Skip to content
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.

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

docs: document git user config before trigger workflow #991

Merged
merged 2 commits into from
Jan 9, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
docs: show examples of git user config in trigger workflow
  • Loading branch information
dhayab committed Jan 9, 2023
commit 6fa63d0539c02d338dbe7c524460666edda739ea
5 changes: 4 additions & 1 deletion packages/shipjs/src/step/setup/CI/addCircleCIConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,10 @@ jobs:
- save_cache: *save_yarn_cache
- run:
name: Triggering Ship.js to Release
command: yarn shipjs trigger
command: |
git config --global user.email "<%= gitUserEmail %>"
git config --global user.name "<%= gitUserName %>"
yarn shipjs trigger
workflows:
version: 2
release_if_needed:
Expand Down
5 changes: 4 additions & 1 deletion website/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,10 @@ jobs:
command: yarn install
- run:
name: Triggering Ship.js to Release
command: yarn shipjs trigger
command: |
git config --global user.email "[email protected]"
git config --global user.name "Your Name"
yarn shipjs trigger
workflows:
version: 2
release_if_needed:
Expand Down
2 changes: 1 addition & 1 deletion website/guide/useful-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ For example, you normally work on `develop` and want to have the latest release
```js
module.exports = {
afterPublish: ({ exec }) => {
exec(`git config --global user.email "your@email.com"`);
exec(`git config --global user.email "you@example.com"`);
exec(`git config --global user.name "Your Name"`);

exec('git checkout master');
Expand Down