Skip to content

Commit d6e2cd6

Browse files
committed
Updating readme notes 📝
1 parent 2fe0c8e commit d6e2cd6

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ Miscellaneous GitHub scripts, `gh` commands, API calls, GraphQL queries, etc. fo
44

55
See the folder categories:
66
- [api](/api)
7-
- [gh cli](gh-cli) 🚀 ✨ ⬅️ most updated!
7+
- [gh cli](gh-cli) 🚀 ✨ ⬅️ *most updated!*
88
- [git](git)
99
- [graphql](graphql)
1010
- [scripts](scripts)
1111

12-
> **Note**: The **[gh cli](gh-cli)** folder is the most maintained; I've started adding both API and GraphQL queries in there using `gh api` commands.
12+
> **Important**
13+
> The **[gh cli](gh-cli)** folder is the most maintained; I've started adding both API and GraphQL queries in there using `gh api` commands.

gh-cli/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ You can have more complex mappings this just a basic example, where a copy is be
122122

123123
Copy team member from one team to another, it respect source role type (maintainer, member).
124124

125-
> **Note** Only direct members are copied, child team members are not copied.
125+
> **Note**
126+
> Only direct members are copied, child team members are not copied.
126127
127128
If the target team already has user they will be preserved, this **doesn't** synch members between teams, it merely copies them. If you want a synch then you need to delete the existem team members in the target team before running this script.
128129

@@ -191,10 +192,11 @@ It copies all [environments](https://docs.github.com/en/actions/deployment/targe
191192
- [Wait Timer](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#wait-timer)
192193
- [Deployment Branches](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)
193194

194-
> **Note** The following settings are **not** copied:
195-
- [Environment Variables](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-variables)
196-
- [Custom Deployment Protection Rules](https://docs.github.com/en/actions/deployment/protecting-deployments/configuring-custom-deployment-protection-rules#using-existing-custom-deployment-protection-rules)
197-
- Secrets
195+
> **Note**
196+
> The following settings are **not** copied:
197+
> - [Environment Variables](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-variables)
198+
> - [Custom Deployment Protection Rules](https://docs.github.com/en/actions/deployment/protecting-deployments/configuring-custom-deployment-protection-rules#using-existing-custom-deployment-protection-rules)
199+
> - Secrets
198200
199201
## copy-repository-variables.sh
200202

@@ -215,7 +217,8 @@ External collaborators are not copied intentionally.
215217

216218
If the team on the target organization doesn't exist, one will be created (same name, description, privacy, and notification settings ONLY).
217219

218-
> **Note** The created team will not be a full copy, **Only** name and description are honored. If the team is part of a child/parent relationship, or it's associated with an IDP group it will not be honored. If you want to change this behavior, you can modify the `createTeamIfNotExists` function.
220+
> **Note**
221+
> The created team will not be a full copy, **Only** name and description are honored. If the team is part of a child/parent relationship, or it's associated with an IDP group it will not be honored. If you want to change this behavior, you can modify the `createTeamIfNotExists` function.
219222
220223
This script requires 2 environment variables (with another optional one):
221224

@@ -239,7 +242,8 @@ On Enterprise Managed Users organizations the users are only added if they are p
239242

240243
On GitHub Enterprise Cloud the added users will get an invitation to join the organization.
241244

242-
> **Warning** For GitHub Enterprise Cloud the number of users you can copy in a day is limited per target org. See [API note on rate limits](https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/members?apiVersion=2022-11-28#set-organization-membership-for-a-user) for the limit values.
245+
> **Warning**
246+
> For GitHub Enterprise Cloud the number of users you can copy in a day is limited per target org. See [API note on rate limits](https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/members?apiVersion=2022-11-28#set-organization-membership-for-a-user) for the limit values.
243247
244248
This script requires 2 environment variables (with another optional one):
245249

@@ -558,7 +562,7 @@ Get outside collaborators added to a repository
558562

559563
Retrieve the download URL for the latest version of a package in GitHub Packages. See: [Documentation](https://docs.github.com/en/graphql/reference/objects#package)
560564

561-
> **Note:**
565+
> **Note**
562566
> No longer works for GitHub.com and deprecated for GHES 3.7+. See [Changelog post](https://github.blog/changelog/2022-08-18-deprecation-notice-graphql-for-packages/), [GraphQL breaking changes](https://docs.github.com/en/graphql/overview/breaking-changes#changes-scheduled-for-2022-11-21-1), and [GHES 3.7 deprecations](https://docs.github.com/en/[email protected]/admin/release-notes#3.7.0-deprecations)
563567
564568
## get-package-download-url-for-specific-version-maven.sh
@@ -577,7 +581,7 @@ Retrieve the download URL for a specific version of an Maven package in GitHub P
577581

578582
Retrieve the download URL for a specific version of a package in GitHub Packages. See: [Documentation](https://docs.github.com/en/graphql/reference/objects#package)
579583

580-
> **Note:**
584+
> **Note**
581585
> No longer works for GitHub.com and deprecated for GHES 3.7+. See [Changelog post](https://github.blog/changelog/2022-08-18-deprecation-notice-graphql-for-packages/), [GraphQL breaking changes](https://docs.github.com/en/graphql/overview/breaking-changes#changes-scheduled-for-2022-11-21-1), and [GHES 3.7 deprecations](https://docs.github.com/en/[email protected]/admin/release-notes#3.7.0-deprecations)
582586
583587
## get-pull-requests-in-organization.sh

0 commit comments

Comments
 (0)