Skip to content

Support deploying via Github Actions using deploy --ci command #1460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ang-zeyu merged 7 commits into from
Feb 1, 2021
Merged

Support deploying via Github Actions using deploy --ci command #1460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
59eeebf
Add initial modifications
raysonkoh Jan 26, 2021
d2d34a8
Update user for gh-action
raysonkoh Jan 26, 2021
3ce1219
Fix failing tests
raysonkoh Jan 30, 2021
baaedd2
Update deploy url to include x-access-token
raysonkoh Jan 31, 2021
4873ff2
Update userGuide
raysonkoh Jan 31, 2021
84e5cd4
Fix typo in userGuide
raysonkoh Jan 31, 2021
754dd5a
Update userGuide
raysonkoh Feb 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions docs/userGuide/deployingTheSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,41 @@ You can override the default deployment settings %%(e.g., repo/branch to deploy)
### Deploying to GitHub Pages via CI Tools
**You can setup CI Tools to automatically build and deploy your site on GitHub Pages every time your GitHub repo is updated.**

<box type="important" light>
<panel header="#### Deploying via Github Actions" type="seamless" expanded>

Markbind currently supports deploying to Github Pages via [Travis CI](https://www.travis-ci.com/) or [AppVeyor CI](https://www.appveyor.com/).
To instruct [Github Actions](https://docs.github.com/en/actions) to build and deploy the site when you push to the repository, add a Github Actions workflow file in your project repo at the location `<PROJECT_ROOT>/.github/workflows/deploy.yml` A sample workflow file is provided below:
```
name: Deploy Markbind Site
on:
push:
branches: master

jobs:
build:
runs-on: ubuntu-latest
name: test
env:
GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '10'
- run: npm i -g markbind-cli
- run: markbind build
- run: markbind deploy --ci
```

<box type="info">

The sample `deploy.yml` workflow above uses the [default Github Token secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) that is generated automatically for each Github Actions workflow. You may also use a Github Personal Access Token in place of the default Github Token. For steps on setting up your Github Personal Access Token, you may refer to the [setup instructions for Travis CI](#configuring-your-repository-in-travis-ci).
</box>

Once you have created the file, commit and push the file to your repo. Github Actions should start to build and deploy your markbind site. You can verify this by visiting `www.github.com/<org|username>/<repo>/actions`.

For more information on customizing your workflow file to fit your specific needs, you may refer to the [Github Action Docs](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions).

</panel>

@ang-zeyu ang-zeyu Feb 1, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we add a tip / note here that the example is using github's app token?

Also that personal / org tokens would also work (can refer to travis section for setup instructions)

@raysonkoh raysonkoh Feb 1, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup I've added an info box for this.


<panel header="#### Deploying via Travis CI" type="seamless" expanded>

Expand Down
13 changes: 12 additions & 1 deletion packages/core/src/Site/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1174,11 +1174,22 @@ class Site {
name: 'AppVeyorBot',
email: 'deploy@appveyor.com',
};
} else if (process.env.GITHUB_ACTIONS) {
if (options.repo) {
repoSlug = Site.extractRepoSlug(options.repo);
} else {
repoSlug = process.env.GITHUB_REPOSITORY;
}

options.user = {
name: 'github-actions',
email: 'github-actions@github.com',
};
} else {
throw new Error('-c/--ci should only be run in CI environments.');
}

options.repo = `https://${githubToken}@github.com/${repoSlug}.git`;
options.repo = `https://x-access-token:${githubToken}@github.com/${repoSlug}.git`;
}

publish(basePath, options);
Expand Down
17 changes: 13 additions & 4 deletions packages/core/test/unit/Site.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,13 @@ describe('Site deploy with various CI environments', () => {

beforeEach(() => {
// Delete all environment variables that affect tests
delete process.env.TRAVIS;
delete process.env.GITHUB_TOKEN;
delete process.env.TRAVIS;
delete process.env.TRAVIS_REPO_SLUG;
delete process.env.APPVEYOR;
delete process.env.APPVEYOR_REPO_NAME;
delete process.env.GITHUB_ACTIONS;
delete process.env.GITHUB_REPOSITORY;
});

afterAll(() => {
Expand All @@ -297,6 +299,7 @@ describe('Site deploy with various CI environments', () => {
test.each([
['TRAVIS', 'TRAVIS_REPO_SLUG', { name: 'Deployment Bot', email: 'deploy@travis-ci.org' }],
['APPVEYOR', 'APPVEYOR_REPO_NAME', { name: 'AppVeyorBot', email: 'deploy@appveyor.com' }],
['GITHUB_ACTIONS', 'GITHUB_REPOSITORY', { name: 'github-actions', email: 'github-actions@github.com' }],
])('Site deploy -c/--ci deploys with default settings',
async (ciIdentifier, repoSlugIdentifier, deployBotUser) => {
process.env[ciIdentifier] = true;
Expand All @@ -312,13 +315,15 @@ describe('Site deploy with various CI environments', () => {
const site = new Site('./', '_site');
await site.deploy(true);
expect(ghpages.options.repo)
.toEqual(`https://${process.env.GITHUB_TOKEN}@github.com/${process.env[repoSlugIdentifier]}.git`);
// eslint-disable-next-line max-len
.toEqual(`https://x-access-token:${process.env.GITHUB_TOKEN}@github.com/${process.env[repoSlugIdentifier]}.git`);
expect(ghpages.options.user).toEqual(deployBotUser);
});

test.each([
['TRAVIS', 'TRAVIS_REPO_SLUG'],
['APPVEYOR', 'APPVEYOR_REPO_NAME'],
['GITHUB_ACTIONS', 'GITHUB_REPOSITORY'],
])('Site deploy -c/--ci deploys with custom GitHub repo',
async (ciIdentifier, repoSlugIdentifier) => {
process.env[ciIdentifier] = true;
Expand All @@ -336,12 +341,13 @@ describe('Site deploy with various CI environments', () => {
const site = new Site('./', '_site');
await site.deploy(true);
expect(ghpages.options.repo)
.toEqual(`https://${process.env.GITHUB_TOKEN}@github.com/USER/REPO.git`);
.toEqual(`https://x-access-token:${process.env.GITHUB_TOKEN}@github.com/USER/REPO.git`);
});

test.each([
['TRAVIS', 'TRAVIS_REPO_SLUG'],
['APPVEYOR', 'APPVEYOR_REPO_NAME'],
['GITHUB_ACTIONS', 'GITHUB_REPOSITORY'],
])('Site deploy -c/--ci deploys to correct repo when .git is in repo name',
async (ciIdentifier, repoSlugIdentifier) => {
process.env[ciIdentifier] = true;
Expand All @@ -357,7 +363,8 @@ describe('Site deploy with various CI environments', () => {
const site = new Site('./', '_site');
await site.deploy(true);
expect(ghpages.options.repo)
.toEqual(`https://${process.env.GITHUB_TOKEN}@github.com/${process.env[repoSlugIdentifier]}.git`);
// eslint-disable-next-line max-len
.toEqual(`https://x-access-token:${process.env.GITHUB_TOKEN}@github.com/${process.env[repoSlugIdentifier]}.git`);
});

test('Site deploy -c/--ci should not deploy if not in CI environment', async () => {
Expand All @@ -378,6 +385,7 @@ describe('Site deploy with various CI environments', () => {
test.each([
['TRAVIS'],
['APPVEYOR'],
['GITHUB_ACTIONS'],
])('Site deploy -c/--ci should not deploy without authentication token', async (ciIdentifier) => {
process.env[ciIdentifier] = true;

Expand All @@ -396,6 +404,7 @@ describe('Site deploy with various CI environments', () => {
test.each([
['TRAVIS'],
['APPVEYOR'],
['GITHUB_ACTIONS'],
])('Site deploy -c/--ci should not deploy if custom repository is not on GitHub', async (ciIdentifier) => {
process.env[ciIdentifier] = true;
process.env.GITHUB_TOKEN = 'githubToken';
Expand Down