Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Added API docs for using Safe Settings #634

Merged

Conversation

primetheus
Copy link
Contributor

@primetheus primetheus commented May 26, 2024

This provides a more clear set of documentation that is based on GitHub's API docs. It makes it more clear how one can structure their YAML files to function properly

cc: @decyjphr

@primetheus primetheus changed the title Added API docs for using Safe Settings Docs: Added API docs for using Safe Settings May 26, 2024
@ElioDiNino
Copy link
Contributor

Hey @primetheus, this is really great and I hope it gets merged in. I notice that you are missing docs for milestones and rulesets though. Do you plan on adding this?

@decyjphr
Copy link
Collaborator

decyjphr commented Jun 4, 2024

@primetheus thank you!
I agree this is a great addition and gives us a template for adding content for other settings.

@decyjphr decyjphr merged commit fe55275 into github:main-enterprise Jun 4, 2024
1 check passed
maxflintoff-tomtom pushed a commit to tomtom-forks/safe-settings that referenced this pull request Jun 19, 2024
github-merge-queue bot pushed a commit to tomtom-forks/safe-settings that referenced this pull request Jun 21, 2024
* added API docs for using Safe Settings (github#634)

* docs: update and consolidate documentation (github#643)

* docs: update and consolidate documentation

* docs(readme): fix formatting

* Update CRON schedule to address rate limit issues (github#631)

* Upgrade to node.js 20 (github#609)

* chore: fix issues with logging in tests

Fix errors thrown by lack of child function in logging stubs

* chore: fix branches tests

Fix the branch tests to include default properties

---------

Co-authored-by: primetheus <[email protected]>
Co-authored-by: Elio Di Nino <[email protected]>
Co-authored-by: Igor Costa <[email protected]>
Co-authored-by: Benjamin Manuel <[email protected]>
admtorgst pushed a commit to helse-sorost/safe-settings that referenced this pull request Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants