Skip to content

docs: updating semantic pull request docs #174

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.

Sign up for GitHub

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

Merged
tomarra merged 9 commits into from
Mar 5, 2024
Merged

docs: updating semantic pull request docs #174

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
041333c
updating semantic pull request docs
verygoodstefan Feb 2, 2024
979c161
Apply suggestions from code review
alestiago Feb 8, 2024
15de7ac
Update site/docs/workflows/semantic_pull_request.md
alestiago Feb 8, 2024
2ad0336
docs: update sections
alestiago Feb 8, 2024
3aaa24d
docs: markdown paragraph
alestiago Feb 8, 2024
4c2a066
Merge branch 'main' into docs/update_semantic_pull_request
alestiago Feb 8, 2024
8bd1c3b
chore: prettier fix
alestiago Feb 8, 2024
4685756
Merge branch 'docs/update_semantic_pull_request' of https://github.co…
alestiago Feb 8, 2024
0c05d5a
Merge branch 'main' into docs/update_semantic_pull_request
tomarra Mar 5, 2024
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
8 changes: 7 additions & 1 deletion site/docs/workflows/semantic_pull_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,13 @@ The semantic pull request package workflow consists of the following step:

**Optional** Configure which scopes are allowed (e.g. `"dart_package, flutter_package"`).

## GitHub Permissions
## GitHub Repository Configuration

### Squash Merging

To verify that this workflow will properly evaluate your pull request messages, we recommend configuring your GitHub repository to [allow squash merging](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests) and setting the [default commit message](https://github.blog/changelog/2022-08-23-new-options-for-controlling-the-default-commit-message-when-merging-a-pull-request/) to "Pull request title."

### GitHub Permissions

When running this workflow, the `GITHUB_TOKEN` has to have the correct permissions to run successfully. On public repositories, the default settings grant the token enough permissions to run correctly. However, on private repositories, settings have to be updated. There are two ways of doing so:

Expand Down