dsacms/repo-sunsetter
A GitHub Action to prepare a repository for archival
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | GitHub token for authentication and creating issues & PRs | yes | — |
| METADATA_FILE_TYPE | Metadata file in the repository (e.g. code.json, codemeta, publiccode.yml) | no | code.json |
| USE_MATURITY_MODEL_TIERS | Flag to determine if maturity model tiers should be used for issue generation | yes | false |
| CHECKLIST_LINK | A link to the archival checklist to be included in the issue body. The checklist must be in the form of a .md file. The link must serve the file as a static raw text file (i.e. uses raw.githubusercontent.com). Only used if USE_MATURITY_MODEL_TIERS is false | no | https://raw.githubusercontent.com/DSACMS/repo-sunsetter/main/checklists/TEMPLATE_ARCHIVAL_CHECKLIST.md |
| ARCHIVE_NOTICE_TEXT | Custom text to include in the archival notice (optional) | no | This project is now archived and no longer actively maintained. It has been archived to retain its contents for reference. Feel free to explore and fork the repository, but please note that updates or support will not be provided. |
Outputs
| name | description |
|---|---|
| archival_checklist_issue_number | The created issue number |
| archival_checklist_issue_url | The URL of the created issue |
| metadata_update_pull_request_url | The URL of the pull request for the metadata file update |
| readme_pull_request_number | The pull request number for the README update |
| readme_pull_request_url | The URL of the pull request for the README update |