-
-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
229 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| add-issues-wo-labels=true | ||
| add-pr-wo-labels=true | ||
| author=true | ||
| breaking-labels=backwards-incompatible, Backwards incompatible, breaking | ||
| breaking-prefix=### Breaking changes | ||
| bug-labels=bug - confirmed | ||
| bug-prefix=### Fixes | ||
| compare-link=true | ||
| date-format=%Y-%m-%d | ||
| deprecated-labels=deprecated, Deprecated, Type: Deprecated | ||
| deprecated-prefix=### Deprecates | ||
| enhancement-labels=improvement, documentation, builds / deploys / releases, feature request | ||
| enhancement-prefix=### Changes | ||
| exclude-labels=bug - unconfirmed, can't reproduce / won't fix, invalid, triage | ||
| filter-issues-by-milestone=true | ||
| header= | ||
| http-cache=true | ||
| issues=true | ||
| issue-prefix=### Closes | ||
| merge-prefix=### Pull request(s) without label | ||
| output= | ||
| project=phpcodesniffer-composer-installer | ||
| pulls=true | ||
| removed-labels=removed, Removed, Type: Removed | ||
| removed-prefix=### Removes | ||
| security-labels=security, Security, Type: Security | ||
| security-prefix=### Security | ||
| summary-labels=Release summary, release-summary, Summary, summary | ||
| unreleased=true | ||
| unreleased-label=Unreleased | ||
| unreleased-only=true | ||
| user=Dealerdirect | ||
| usernames-as-github-logins=true | ||
| verbose=false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ When contributing to this repository, please first discuss the change you wish | |
| to make via issue, email, or any other method with the owners of this repository | ||
| before making a change. | ||
|
|
||
| Please note we have a code of conduct, please follow it in all your interactions | ||
| Please note we have [a code of conduct](#code-of-conduct), please follow it in all your interactions | ||
| with the project. | ||
|
|
||
| ## Issues and feature requests | ||
|
|
@@ -25,5 +25,114 @@ Even better: You could submit a pull request with a fix / new feature! | |
| developers, or if you do not have permission to do that, you may request | ||
| the second reviewer to merge it for you. | ||
|
|
||
| ## Release process | ||
|
|
||
| To make it possible to automatically generate a changelog, all tickets/issues must have a milestone and at least one label. | ||
|
|
||
| A changelog can be generated using the [`github-changelog-generator`][github-changelog-generator].[<sup>(1)</sup>](#footnotes) | ||
|
|
||
| Our release versions follow [Semantic Versioning][semver]. | ||
|
|
||
| New releases (and any related tags) are always created from the `master` branch. | ||
|
|
||
| To create a new release: | ||
|
|
||
| 1. Make sure all closed tickets and MRs have a label. | ||
|
|
||
| 2. Make sure all closed tickets and MRs are added to the milestone that is to be released. | ||
|
|
||
| 3. Move any open tickets to the next milestone (create a new one if needed). | ||
|
|
||
| 4. Generate a changelog by running `github_changelog_generator` in the project root:[<sup>(2)</sup>](#footnotes) | ||
| ``` | ||
| github_changelog_generator --future-release "${sVersion}" --header --output --unreleased-only 2>/dev/null | ||
| ``` | ||
| Where `sVersion` contains the new version to release. | ||
|
|
||
| 5. Use GitHub "Draft a new release" functionality to draft a new release (this also creates a tag). | ||
|
|
||
| 6. Close the milestone for the version that was just released. | ||
|
|
||
| ## Code of conduct | ||
|
|
||
| ### Our pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, gender identity and expression, level of experience, | ||
| nationality, personal appearance, race, religion, or sexual identity and | ||
| orientation. | ||
|
|
||
| ### Our standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment | ||
| include: | ||
|
|
||
| - Using welcoming and inclusive language | ||
| - Being respectful of differing viewpoints and experiences | ||
| - Gracefully accepting constructive criticism | ||
| - Focusing on what is best for the community | ||
| - Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| - The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| - Trolling, insulting/derogatory comments, and personal or political attacks | ||
| - Public or private harassment | ||
| - Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
| - Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ### Our responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
|
|
||
| ### Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project e-mail | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ### Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [email protected]. All | ||
| complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and appropriate to the circumstances. The project team is | ||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||
| Further details of specific enforcement policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership. | ||
|
|
||
| ### Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ | ||
| [github]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues | ||
| [prs]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/pulls | ||
|
|
||
| ## Footnotes | ||
|
|
||
| 1. All settings needed for the changelog-generator are set in `.github_changelog_generator` file. | ||
|
|
||
| 2. A convenience script is present at `bin/generate-changelog.sh` that will install the changelog-generator, if it is not present, and run the appropriate `github_changelog_generator` command. | ||
| The script requires BASH to run. It should be run from the project root, similar to `github_changelog_generator`. | ||
|
|
||
| [github-changelog-generator]: https://github.com/github-changelog-generator/github-changelog-generator/ | ||
| [semver]: https://semver.org/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -o errexit -o errtrace -o nounset -o pipefail | ||
|
|
||
| : ${GITHUB_CHANGELOG_GENERATOR:=github_changelog_generator} | ||
| : ${GEM:=gem} | ||
|
|
||
| generate_changelog() { | ||
| local -r sVersion="${1?One parameter required: <release-to-generate>}" | ||
|
|
||
| if ! command -v "${GITHUB_CHANGELOG_GENERATOR}" >/dev/null 2>&1;then | ||
| echo "This script requires the '${GITHUB_CHANGELOG_GENERATOR}' Ruby Gem" | ||
|
|
||
| if ! command -v "${GEM}" >/dev/null 2>&1;then | ||
| echo "Could not find the '${GEM}' command needed to install 'github_changelog_generator'!" >&2 | ||
| echo 'Aborting.' | ||
| exit 67 | ||
| else | ||
| echo "Installing '${GITHUB_CHANGELOG_GENERATOR}'..." | ||
| gem install github_changelog_generator | ||
| fi | ||
| fi | ||
|
|
||
| local -r sChangelog="$( | ||
| "${GITHUB_CHANGELOG_GENERATOR}" \ | ||
| --user Dealerdirect \ | ||
| --project phpcodesniffer-composer-installer \ | ||
| --token "$(cat ~/.github-token)" \ | ||
| --future-release "${sVersion}" \ | ||
| --enhancement-label '### Changes' \ | ||
| --bugs-label '### Fixes' \ | ||
| --issues-label '### Closes' \ | ||
| --usernames-as-github-logins \ | ||
| --bug-labels 'bug - confirmed' \ | ||
| --enhancement-labels 'improvement','documentation','builds / deploys / releases','feature request' \ | ||
| --exclude-labels 'bug - unconfirmed',"can't reproduce / won't fix",'invalid','triage' \ | ||
| --unreleased-only \ | ||
| --output '' 2>/dev/null | ||
| )" || echo "There was a problem running '${GITHUB_CHANGELOG_GENERATOR}'" | ||
|
|
||
| echo "${sChangelog}" | sed -E 's/\[\\(#[0-9]+)\]\([^)]+\)/\1/' | head -n -3 | ||
| } | ||
|
|
||
| if [[ "${BASH_SOURCE[0]}" != "$0" ]]; then | ||
| export -f generate_changelog | ||
| else | ||
| generate_changelog "${@}" | ||
| exit $? | ||
| fi |