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

Document release process #118

Merged

Conversation

Potherca
Copy link
Member

This MR documents the basic steps required to create a new release in the contributing file.

It also add github_changelog_generator setting file and a script to run the changelog generator.

Closes #114

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

Thanks for setting this up @Potherca !

I've got a few questions and other than that, just some small grammar/punctuation nitpicks. Please see my remarks inline.

Note: I haven't tested the script.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
bin/generate-changelog.sh Show resolved Hide resolved
bin/generate-changelog.sh Show resolved Hide resolved
@Potherca
Copy link
Member Author

@jrfnl I finally managed to find some time to go through your feedback. I think I got it all, could you check at your convenience?

Potherca and others added 5 commits January 31, 2021 13:12
- Make footnote markers a link to the footnotes section
- Mention that either generate command needs to be run from the project root
- Mention that the `.sh` script required BASH to run
- Fix Code of Conduct link
@Potherca
Copy link
Member Author

I'm going to merge this, to keep things moving.

@Potherca Potherca force-pushed the issues/114-release-process branch from 6559199 to a9990e9 Compare January 31, 2021 14:02
@Potherca Potherca merged commit 97aa24e into PHPCSStandards:master Jan 31, 2021
@Potherca Potherca deleted the issues/114-release-process branch January 31, 2021 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document current "Create a release" process
2 participants