https://github.com/im-open/is-actor-team-member
Checks if the github actor is a member of a specific GitHub team. If
https://github.com/im-open/is-actor-team-member
authorization infra-purple-team meta
Last synced: over 1 year ago
JSON representation
Checks if the github actor is a member of a specific GitHub team. If
- Host: GitHub
- URL: https://github.com/im-open/is-actor-team-member
- Owner: im-open
- License: mit
- Created: 2023-12-18T15:59:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T16:56:54.000Z (about 2 years ago)
- Last Synced: 2025-01-23T16:14:56.653Z (over 1 year ago)
- Topics: authorization, infra-purple-team, meta
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Is Actor Team Member
This template can be used to quickly start a new custom js action repository. Click the `Use this template` button at the top to get started.
## Index
- [Is Actor Team Member](#is-actor-team-member)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Usage Examples](#usage-examples)
- [Contributing](#contributing)
- [Incrementing the Version](#incrementing-the-version)
- [Source Code Changes](#source-code-changes)
- [Recompiling Manually](#recompiling-manually)
- [Updating the README.md](#updating-the-readmemd)
- [Tests](#tests)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Inputs
| Parameter | Is Required | Default | Description |
|-----------------------|-------------|---------|--------------------------------------------------------------------|
| `github-actor` | true | | The GitHub actor to check for membership |
| `github-organization` | true | | The GitHub organization to check for membership |
| `github-team-slugs` | true | | The GitHub team slugs to check for membership |
| `github-token` | true | | The GitHub token to use for authentication |
| `github-usernames` | false | | If github username is not part of team, they can be specified here |
## Usage Examples
```yml
jobs:
deploy-to-prod:
runs-on: [self-hosted, im-linux]
steps:
- uses: actions/checkout@v4
- name: Check if Actor is a Member of one of the teams
uses: im-open/is-actor-team-member@v1.2.0
with:
github-actor: ${{ github.actor }}
github-organization: my-github-org
github-team-slugs: |
[
"team-one",
"team-two"
]
github-usernames: |
[
"super-duper-user"
]
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy the Code
run: |
```
## Contributing
When creating PRs, please review the following guidelines:
- [ ] The action code does not contain sensitive information.
- [ ] At least one of the commit messages contains the appropriate `+semver:` keywords listed under [Incrementing the Version] for major and minor increments.
- [ ] The action has been recompiled. See [Recompiling Manually] for details.
- [ ] The README.md has been updated with the latest version of the action. See [Updating the README.md] for details.
- [ ] Any tests in the [build-and-review-pr] workflow are passing
### Incrementing the Version
This repo uses [git-version-lite] in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if [source code] changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.
| Increment Type | Commit Message Fragment |
|----------------|---------------------------------------------|
| major | +semver:breaking |
| major | +semver:major |
| minor | +semver:feature |
| minor | +semver:minor |
| patch | *default increment type, no comment needed* |
### Source Code Changes
The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows.
If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The [build-and-review-pr] workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.
If a PR consists solely of non-source code changes like changes to the `README.md` or workflows under `./.github/workflows`, version updates and recompiles do not need to be performed.
### Recompiling Manually
This command utilizes [esbuild] to bundle the action and its dependencies into a single file located in the `dist` folder. If changes are made to the action's [source code], the action must be recompiled by running the following command:
```sh
# Installs dependencies and bundles the code
npm run build
```
### Updating the README.md
If changes are made to the action's [source code], the [usage examples] section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See [Incrementing the Version] for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.
### Tests
The build and review PR workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, there should not be any issues running the tests. When a PR comes from a fork, tests may not have the required permissions or access to run since the `GITHUB_TOKEN` only has `read` access set for all scopes. Also, forks cannot access other secrets in the repository. In these scenarios, a fork may need to be merged into an intermediate branch by the repository owners to ensure the tests run successfully prior to merging to the default branch.
## Code of Conduct
This project has adopted the [im-open's Code of Conduct](https://github.com/im-open/.github/blob/main/CODE_OF_CONDUCT.md).
## License
Copyright © 2023, Extend Health, LLC. Code released under the [MIT license](LICENSE).
[Incrementing the Version]: #incrementing-the-version
[Recompiling Manually]: #recompiling-manually
[source code]: #source-code-changes
[Updating the README.md]: #updating-the-readmemd
[usage examples]: #usage-examples
[build-and-review-pr]: ./.github/workflows/build-and-review-pr.yml
[increment-version-on-merge]: ./.github/workflows/increment-version-on-merge.yml
[esbuild]: https://esbuild.github.io/getting-started/#bundling-for-node
[git-version-lite]: https://github.com/im-open/git-version-lite