https://github.com/cucumber/action-retire-inactive-contributors

Retire inactive contributors from one team to another
https://github.com/cucumber/action-retire-inactive-contributors

Last synced: 8 months ago
JSON representation

Retire inactive contributors from one team to another

• Host: GitHub
• URL: https://github.com/cucumber/action-retire-inactive-contributors
• Owner: cucumber
• License: isc
• Created: 2022-01-28T16:31:59.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-07T11:41:14.000Z (about 2 years ago)
• Last Synced: 2024-04-14T13:08:34.412Z (about 2 years ago)
• Language: TypeScript
• Size: 1.56 MB
• Stars: 4
• Watchers: 11
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Cucumber Report](https://messages.cucumber.io/api/report-collections/e37b01e9-023e-43aa-b510-a79705ee932f/badge)](https://reports.cucumber.io/report-collections/e37b01e9-023e-43aa-b510-a79705ee932f)

# retire-inactive-contributor README.md

This is one result of [the new contributors ensemble, a weekly exercise in ensemble programming.](https://cucumber.io/docs/community/new-contributors/)

## Now as a Github action

When this Github action runs:

    - It requests a list of all contributors

    - Moves inactive contributors to a less-privileged alumni team 

    - If an inactive contributor has custom permissions, these permissions are revoked

![Sequence Diagram](doc/diagrams/sequence.png)

## Usage Example

Add this text to your workflow config `.github/workflows/main.yml`

```yaml

name: Retire inactive contributors

on:

  schedule:

    # https://crontab.guru/every-night-at-midnight

    - cron: "0 0 * * *"

jobs:

  retire-inactive:

    runs-on: ubuntu-latest

    steps:

      - uses: cucumber/action-retire-inactive-contributor@main

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        with:

          github-orgname: cucumber

          maximum-absence-before-retirement: 1 year

          alumni-team: Alumni

```

> Previously, a bot built with [Probot](https://github.com/probot/probot) that Retire inactive contributors from one team to another, now done using a GitHub Action

## Setup

The current project code is based on the sample TypeScript action available at https://github.com/actions/typescript-action

If you are using VSCode you can also use the following workspace settings for Prettier/ESLint:

```

{

	"editor.formatOnSave": true,

	"[typescript]": {

		"editor.formatOnSave": false,

		"editor.defaultFormatter": "esbenp.prettier-vscode"

	},

	"editor.codeActionsOnSave": {

		"source.fixAll.eslint": true

	}

}

```

## Contributing

If you have suggestions for how inactive-contributor-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2022 Matt Wynne, Kate Dames, Blaise Pabon