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: seed CONTRIBUTING.md with pr title and changelog expectations #12361

Merged
merged 5 commits into from
Aug 8, 2024

Conversation

BigLep
Copy link
Member

@BigLep BigLep commented Aug 8, 2024

This starts on #12360 as part of landing #12340

@BigLep BigLep added the skip/changelog This change does not require CHANGELOG.md update label Aug 8, 2024 — with GitHub Codespaces
@BigLep BigLep requested a review from rjan90 August 8, 2024 17:58
@BigLep BigLep self-assigned this Aug 8, 2024
@BigLep BigLep marked this pull request as ready for review August 8, 2024 17:59
Copy link
Contributor

@rjan90 rjan90 left a comment

Choose a reason for hiding this comment

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

Fixed a couple of typos and replaced # with // for comments in the pr-title-check.yml file. The # comments were invalid in JavaScript, causing the check to fail.

After those has been applied, this PR should be fine to merge into the phi/PR-title-check branch, and then we can continue to land your suggestion: #12340

.github/workflows/pr-title-check.yml 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
BigLep and others added 4 commits August 8, 2024 14:42
Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
@BigLep BigLep merged commit 7292875 into phi/PR-title-check Aug 8, 2024
39 checks passed
@BigLep BigLep deleted the biglep/start-contributing.md branch August 8, 2024 21:43
rjan90 added a commit that referenced this pull request Aug 9, 2024
* Add PR title check workflow

Add PR title check workflow

Add colon

Add colon

Request change to PR title instead of blocking PR

Request change to PR title instead of blocking PR

Remove change requested if title conforms to the formate

Remove change requested if title conforms to the formate

* fix: workflow: Ensure PR title check posts review comments

fix: workflow: Ensure PR title check posts review comments

* Add fail if title is invalid

Add fail if title is invalid

* fix: workflow: Ensure PR title check fails for invalid titles

fix: workflow: Ensure PR title check fails for invalid titles

* refactor: pr-title-check: Streamline workflow and reduce complexity

refactor: pr-title-check: Streamline workflow and reduce complexity

* Update allowed PR-types pattern

Update allowed PR-types pattern

* Update pr-title-check.yml

Co-authored-by: Rod Vagg <rod@vagg.org>

* Use conventional commit, but allow for legacy

- Allow optional "[skip changelog]" prefix
- Both <type>: <scope>: and <type>(<scope>): formats
- Use conventional commit "scope" instead of area
- Alphabetize <type> and <scope>

* docs: update pull_request_template.md

Adjust pull_request_template.md according to the changes introduced with the PR title check workflow

* fix(ci): update regex to support both PR title formats

fix(ci): update regex to support both PR title formats

* docs: seed CONTRIBUTING.md with pr title and changelog expectations (#12361)

This starts on #12360 as part of landing #12340

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
rjan90 added a commit to hanabi1224/lotus that referenced this pull request Aug 12, 2024
* Add PR title check workflow

Add PR title check workflow

Add colon

Add colon

Request change to PR title instead of blocking PR

Request change to PR title instead of blocking PR

Remove change requested if title conforms to the formate

Remove change requested if title conforms to the formate

* fix: workflow: Ensure PR title check posts review comments

fix: workflow: Ensure PR title check posts review comments

* Add fail if title is invalid

Add fail if title is invalid

* fix: workflow: Ensure PR title check fails for invalid titles

fix: workflow: Ensure PR title check fails for invalid titles

* refactor: pr-title-check: Streamline workflow and reduce complexity

refactor: pr-title-check: Streamline workflow and reduce complexity

* Update allowed PR-types pattern

Update allowed PR-types pattern

* Update pr-title-check.yml

Co-authored-by: Rod Vagg <rod@vagg.org>

* Use conventional commit, but allow for legacy

- Allow optional "[skip changelog]" prefix
- Both <type>: <scope>: and <type>(<scope>): formats
- Use conventional commit "scope" instead of area
- Alphabetize <type> and <scope>

* docs: update pull_request_template.md

Adjust pull_request_template.md according to the changes introduced with the PR title check workflow

* fix(ci): update regex to support both PR title formats

fix(ci): update regex to support both PR title formats

* docs: seed CONTRIBUTING.md with pr title and changelog expectations (filecoin-project#12361)

This starts on filecoin-project#12360 as part of landing filecoin-project#12340

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
rjan90 added a commit that referenced this pull request Aug 12, 2024
* Add PR title check workflow

Add PR title check workflow

Add colon

Add colon

Request change to PR title instead of blocking PR

Request change to PR title instead of blocking PR

Remove change requested if title conforms to the formate

Remove change requested if title conforms to the formate

* fix: workflow: Ensure PR title check posts review comments

fix: workflow: Ensure PR title check posts review comments

* Add fail if title is invalid

Add fail if title is invalid

* fix: workflow: Ensure PR title check fails for invalid titles

fix: workflow: Ensure PR title check fails for invalid titles

* refactor: pr-title-check: Streamline workflow and reduce complexity

refactor: pr-title-check: Streamline workflow and reduce complexity

* Update allowed PR-types pattern

Update allowed PR-types pattern

* Update pr-title-check.yml

Co-authored-by: Rod Vagg <rod@vagg.org>

* Use conventional commit, but allow for legacy

- Allow optional "[skip changelog]" prefix
- Both <type>: <scope>: and <type>(<scope>): formats
- Use conventional commit "scope" instead of area
- Alphabetize <type> and <scope>

* docs: update pull_request_template.md

Adjust pull_request_template.md according to the changes introduced with the PR title check workflow

* fix(ci): update regex to support both PR title formats

fix(ci): update regex to support both PR title formats

* docs: seed CONTRIBUTING.md with pr title and changelog expectations (#12361)

This starts on #12360 as part of landing #12340

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does not require CHANGELOG.md update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants