docs icon indicating copy to clipboard operation
docs copied to clipboard

Update automatically-generated-release-notes.md

Open katelovescode opened this issue 2 years ago â€ĸ 10 comments

clarifies exclusion configuration example

Why:

Closes 18155

What's being changed:

Adds a description to the existing example and adds an additional example that shows the exclusion method explicitly:

=============== A configuration for a repo that doesn't tag Pull Requests but wants to separate out Dependabot automated PRs in release notes (note: labels: '*' is required to display a catchall category)

# .github/release.yml
changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

================

Check off the following:

  • [x] I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

katelovescode avatar May 23 '22 23:05 katelovescode

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar May 23 '22 23:05 welcome[bot]

Automatically generated comment ℹī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/releasing-projects-on-github/automatically-generated-release-notes.md fpt
ghec
ghes@ 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar May 23 '22 23:05 github-actions[bot]

@katelovescode Thanks so much for opening a PR! I'll get this triaged for review 💖

janiceilene avatar May 24 '22 17:05 janiceilene

Hi @katelovescode 👋đŸģ - thanks for your contribution ✨ Just to let you know that I've asked the relevant team for a technical review on this before I carry out an editorial review. Thanks for your patience 😃

mchammer01 avatar Jun 07 '22 15:06 mchammer01

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Jun 08 '22 17:06 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Jun 16 '22 20:06 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Aug 01 '22 20:08 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Aug 09 '22 20:08 github-actions[bot]

We appreciate your patience as we are working through our backlog 💛

cmwilson21 avatar Aug 10 '22 17:08 cmwilson21

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Oct 28 '22 20:10 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Nov 28 '22 16:11 github-actions[bot]

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Nov 29 '22 17:11 github-actions[bot]

clarifies exclusion configuration example

Why:

Closes 18155

What's being changed:

Adds a description to the existing example and adds an additional example that shows the exclusion method explicitly:

=============== A configuration for a repo that doesn't tag Pull Requests but wants to separate out Dependabot automated PRs in release notes (note: labels: '*' is required to display a catchall category)

# .github/release.yml
changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

================

Check off the following:

  • [x] I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [x] This pull request impacts the contribution experience

    • [x] I have added the 'writer impact' label
    • [x] I have added a description and/or a video demo of the changes below (e.g. a "before and after video") https://github.com/github/docs/pull/18156#issue-1245811159

tharkhay4 avatar Apr 09 '23 06:04 tharkhay4

.github/release.yml

changelog: categories: - title: 🏕 Features labels: - '*' exclude: labels: - dependencies - title: 👒 Dependencies labels: - dependencies

tharkhay4 avatar Apr 09 '23 06:04 tharkhay4

Config file not present. Please add config file at .github/engineering-scorecard.yaml in repository: docs

tharkhay4 avatar Apr 09 '23 06:04 tharkhay4

NICOLE HOOVER

On Sun, Apr 9, 2023, 1:51 AM tharkhay4 @.***> wrote:

clarifies exclusion configuration example Why:

Closes 18155 https://github.com/github/docs/issues/18155 What's being changed:

Adds a description to the existing example and adds an additional example that shows the exclusion method explicitly:

=============== A configuration for a repo that doesn't tag Pull Requests but wants to separate out Dependabot automated PRs in release notes (note: labels: '*' is required to display a catchall category)

.github/release.yml

changelog: categories: - title: 🏕 Features labels: - '*' exclude: labels: - dependencies - title: 👒 Dependencies labels: - dependencies

================ Check off the following:

Writer impact (This section is for GitHub staff members only):

This pull request impacts the contribution experience

— Reply to this email directly, view it on GitHub https://github.com/github/docs/pull/18156#issuecomment-1501055904, or unsubscribe https://github.com/notifications/unsubscribe-auth/A67VL2VYDVUVK4HSZCD2YH3XAJL5VANCNFSM5WXMBOWQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Nicole-reato avatar Apr 10 '23 05:04 Nicole-reato

NICOLE @.***

Nicole-reato avatar Apr 10 '23 06:04 Nicole-reato

NICOLE HOOVER

On Sun, Apr 9, 2023, 1:50 AM tharkhay4 @.***> wrote:

.github/release.yml

changelog: categories:

  • title: 🏕 Features labels:
  • '*' exclude: labels:
  • dependencies
  • title: 👒 Dependencies labels:
  • dependencies

— Reply to this email directly, view it on GitHub https://github.com/github/docs/pull/18156#issuecomment-1501055997, or unsubscribe https://github.com/notifications/unsubscribe-auth/A67VL2SBU2SWVM7NSAZZFV3XAJL37ANCNFSM5WXMBOWQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Nicole-reato avatar Apr 10 '23 06:04 Nicole-reato