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: Update and refactor release workflow recipe #2498

Merged
merged 2 commits into from
Oct 21, 2020

Conversation

silvenon
Copy link
Contributor

@silvenon silvenon commented Oct 9, 2020

🔥 🔥 🔥

  • infer version bump from commits
  • make release commit message adhere to Conventional Commits
  • read GitHub personal access token from git-ignored .env file
  • functions instead of gulp.task
  • eliminate usage of gulp plugins
  • improve readability with execa and pify

I like this recipe because it can be used as inspiration even by those who want to build something completely different.

Ref. #2164.

@silvenon
Copy link
Contributor Author

silvenon commented Oct 9, 2020

The only piece of functionality that I didn't try to test is githubRelease, but I didn't change it, so I'm assuming that it works.

Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

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

Overall, this is looking really good, but I had a few questions/comments.

Also, once you finish up a recipe, please add the Frontmatter like the other docs so it will be pulled in when I publish the website. Thanks!

docs/recipes/automate-release-workflow.md Outdated Show resolved Hide resolved
docs/recipes/automate-release-workflow.md Outdated Show resolved Hide resolved
docs/recipes/automate-release-workflow.md Outdated Show resolved Hide resolved
docs/recipes/automate-release-workflow.md Outdated Show resolved Hide resolved
- infer version bump from commits
- make release commit message adhere to Conventional Commits
- read GitHub personal access token from git-ignored `.env` file
- functions instead of `gulp.task`
- eliminate usage of gulp plugins
- improve readability with `execa` and `util.promisify`
@silvenon
Copy link
Contributor Author

silvenon commented Oct 18, 2020

I forgot to ask, what frontmatter are you referring to? 🤔

@silvenon
Copy link
Contributor Author

Oh, I see the frontmatter now, I'll add it as soon as I figure out which values to add.

Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

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

I made an inline suggestion for the frontmatter, and I also shrunk the name of the recipe.

docs/recipes/automate-release-workflow.md Outdated Show resolved Hide resolved
@silvenon
Copy link
Contributor Author

Got it! Is that it, then?

Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

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

Yep! This looks great! Thank you 😄

@phated phated merged commit 6e56ed8 into gulpjs:master Oct 21, 2020
@phated
Copy link
Member

phated commented Oct 21, 2020

Looks awesome! https://gulpjs.com/docs/en/recipes/automate-releases

Thanks again!

@silvenon silvenon deleted the docs/update-release-recipe branch October 22, 2020 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants