feat(setup): add github actions as CI option

[jeetiss]

closes #346
closes #489

[jeetiss]

I added base and manual config for github actions, but for some reasons, when shipjs prepare runs on github, conventional-changelog detect only latest commit message

I ran from my computer 👉🏻https://github.com/jeetiss/try-shipjs/pull/22/files
And everything okey

This result I saw when trigger ship prepare from action 👉🏻https://github.com/jeetiss/try-shipjs/pull/22/files
Wrong next version because оnly last commit message detected

@uetchy @eunjae-lee any ideas why this happening?

[eunjae-lee]

Ah... this might be because of the recent change I made.
9841f25#diff-aa9168540654167618719f74a15159eaR22
Now it creates a temp file to pass config to conventional-changelog in order to specify the revision range.
We probably need to drop conventional-changelog-cli and instead use its node package directly.
Let me know if this is the case. I will try to work on this issue.

[eunjae-lee]

I just merged #525.
If you update your branch, the problem hopefully will be solved.

[jeetiss]

Thanks 🙌🏻
I am finish working on this PR on weekend

[jeetiss]

@eunjae-lee, I realize, that I can't test #525, and I hope it'll be work!

PR ready for review, I test prepare command with yarn workspace shipjs test:run:setup --dir and Github Actions on my try-shipjs repo!

Last thing that we should discuss about, it is GITHUB_TOKEN

Github Actions have this token on default, but it don't have enough access permissions for push tags and create release, I can't create another token with that name, because of that I choose another name for token 👉🏻 GH_TOKEN

Maybe we should use that name for CircleCI and Github Actions for consistency? Or will be enough just point to it in readme? Ow, readme! I need help with readme!

[eunjae-lee]

Hi @jeetiss 👋🏼,
Thanks for the work!

Was the reason you couldn't test #525 because it wasn't released?

And about GH_TOKEN, when user sets up like it,

GITHUB_TOKEN: \${{ secrets.GH_TOKEN }}

will Ship.js get process.env.GITHUB_TOKEN or process.env.GH_TOKEN?

[jeetiss]

Was the reason you couldn't test #525 because it wasn't released?

Yes.

And about GH_TOKEN

Ship.js can get process.env.GITHUB_TOKEN

but for it user need setup GH_TOKEN in https://github.com/@username/@reponame/settings/secrets/

[eunjae-lee]

Thanks so much for a lot of effort on this PR 🎉
I left some comments.
Let me know how you think.

And I guess we can go with GH_TOKEN and write a proper guide why we decided to do so, instead of forcing all existing users to move on to new env var.
Normally they will use either CircleCI or GitHub Actions. So they will have either GITHUB_TOKEN or GH_TOKEN, but not both of them, right? What do you think?

[jeetiss]

@eunjae-lee I find why prepare fails in github actions, its my fault. actions/checkout on default fetch only 1 commit from history! see fetch-depth param
https://github.com/actions/checkout#usage

and now it should works fine!

[eunjae-lee]

What would be the best way for me to test this PR?
Releasing Ship.js beta version and run it on a repo with GitHub Actions?

[jeetiss]

You can run yarn workspace shipjs test:run:setup --dir ~/workspace/your-test-repository , push it to github and test actions without beta release 😉

[eunjae-lee]

@jeetiss can you take a look at this?
https://github.com/eunjae-lee/dummy-lib-1111/actions

It says there's a syntax error in the yml file.
Do you see any?
https://github.com/eunjae-lee/dummy-lib-1111/commit/488227dda50db643245f55c1d2963102a6104316/checks?check_suite_id=363633924

[jeetiss]

It is private, I see 404

[jeetiss]

I find problem 🤪
My redactor adds some tabs when I copy-paste configs
Nice catch

[eunjae-lee]

Sorry it was private. Now it's public.

I updated the ymls and now I get another error.

https://github.com/eunjae-lee/dummy-lib-1111/commit/9457ec7e93d491bfaf8f5724bf58c94927d487de/checks?check_suite_id=365582870

Can you check it please? I think the error comes from here: https://github.com/algolia/shipjs/blob/master/packages/shipjs-lib/src/lib/git/isWorkingTreeClean.js#L5:L5

And when you see this issue https://github.com/eunjae-lee/dummy-lib-1111/issues/87 ,
the comment is like

and it'd be nice if we get rid of the quote around the comment 🙂

Sorry for not responding to you quickly enough.

[jeetiss]

I don't add support for yarn yet, so action fails with it

npm install creates package-lock.json
shipjs prepare fails with - The working tree is not clean.

https://github.com/eunjae-lee/dummy-lib-1111/commit/9457ec7e93d491bfaf8f5724bf58c94927d487de/checks?check_suite_id=365582870#step:4:1

I can detect that yarn using in repo and change install command in actions or just run npx shipjs prepare
First one need some code, but will run faster. What do you think?

Fix that

Sorry for not responding to you quickly enough.

I don't hurry, lets make better solution 🙌🏻

[eunjae-lee]

@jeetiss Hey,

https://github.com/eunjae-lee/dummy-lib-1111/commit/9748f046a49a6c8b208e5dafccf428841b8b5a27

What about this?
A simple bash if statement to choose which one to use?
It seems to be working :)

https://github.com/eunjae-lee/dummy-lib-1111/commit/9748f046a49a6c8b208e5dafccf428841b8b5a27/checks?check_suite_id=368330939

https://github.com/eunjae-lee/dummy-lib-1111/pull/88

[eunjae-lee]

@jeetiss I guess we can merge this now. What do you think? 🙂

[jeetiss]

Yes, I test all things
And its work with npm too ^_^
jeetiss/try-shipjs#30

Thanks for so simple solution

[eunjae-lee]

Thanks for the amazing work 🎉

[eunjae-lee]

I ran linter and tests on my local, so I'm merging this without waiting for CircleCI,
because they don't run on the PRs from external contributors.