You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is the functionality available through the GitHub API? If the functionality is available, please provide links to the
API documentation (https://developer.github.com/v3/) as well as the Octokit documentation (https://octokit.github.io/).
Octokit documentation forwards to the same area of GitHub docs
If the functionality is not yet available in the API, it would be helpful if you
contacted support (https://support.github.com/) or posted in the Community Forum (https://github.community/). Please
include a link to the forum post if you create one or a copy of the response from support.
New Feature
Ability to archive a repository via an archive flag. It's understood, and implied, that once a repository is archived it would need to be manually unarchived as no additional changes can be made to the settings.yml until its unarchived. Useful in contexts where the settings.yml file is the canonical representation of repository state and managed/generated by external tooling.
The text was updated successfully, but these errors were encountered:
all properties available for the api endpoint that you linked to should work in the repository section of the settings file. have you tried to use the archived boolean property?
@travi sorry for the delay, only got to test it now.
archived: true indeed works. Could be worth including missing properties in the configuration reference, as I was looking at that file as an authoritative source and not obvious that not all properties are present in the example file. The note at the top reads more like "for detailed information on each option consult the API reference".
Prerequisites:
https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories
API documentation (https://developer.github.com/v3/) as well as the Octokit documentation (https://octokit.github.io/).
https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository
contacted support (https://support.github.com/) or posted in the Community Forum (https://github.community/). Please
include a link to the forum post if you create one or a copy of the response from support.
New Feature
Ability to archive a repository via an
archive
flag. It's understood, and implied, that once a repository is archived it would need to be manually unarchived as no additional changes can be made to the settings.yml until its unarchived. Useful in contexts where the settings.yml file is the canonical representation of repository state and managed/generated by external tooling.The text was updated successfully, but these errors were encountered: