From 0206ac31740d50920ac30c25209e5ecc20d11964 Mon Sep 17 00:00:00 2001 From: Kevin Goslar Date: Wed, 22 Jun 2022 03:02:55 -0500 Subject: [PATCH] chore: update dependencies and format (#151) --- .github/workflows/stale.yml | 10 +- .github/workflows/sync.yml | 8 +- .github/workflows/text-run.yml | 2 +- .prettierignore | 3 + CODE_OF_CONDUCT.md | 66 +++-- CONTRIBUTING.md | 202 +++++++++------ README.md | 37 +-- SECURITY.md | 11 +- community_hangouts.md | 230 ++++++++++-------- package-lock.json | 30 +-- package.json | 4 +- releases/kratos/0.5.0-alpha.1.md | 90 ++++--- saved_replies/circleci-blocking-merge.md | 3 +- saved_replies/cla-wrong-e-mail.md | 3 +- saved_replies/docs-update-all-versions.md | 3 +- saved_replies/mark-as-draft.md | 3 +- saved_replies/not-using-issue-template.md | 13 +- .../.github/workflows/release_tagger.yml | 2 +- .../.github/ISSUE_TEMPLATE/BUG-REPORT.yml | 50 ++-- .../.github/ISSUE_TEMPLATE/DESIGN-DOC.yml | 32 +-- .../ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 30 +-- .../repository/common/.github/config.yml | 2 +- .../.github/workflows/closed_references.yml | 6 +- .../common/.github/workflows/stale.yml | 10 +- templates/repository/common/ADOPTERS.md | 24 +- .../repository/common/CODE_OF_CONDUCT.md | 66 +++-- templates/repository/common/CONTRIBUTING.md | 212 +++++++++------- templates/repository/common/PROJECTS.md | 45 ++-- templates/repository/common/SECURITY.md | 11 +- .../library/.github/pull_request_template.md | 6 +- .../server/.github/pull_request_template.md | 6 +- .../server/.github/workflows/milestone.yml | 6 +- 32 files changed, 711 insertions(+), 515 deletions(-) create mode 100644 .prettierignore diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index f8657ac..702e037 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,8 +1,8 @@ -name: 'Close Stale Issues' +name: "Close Stale Issues" on: workflow_dispatch: schedule: - - cron: '0 0 * * *' + - cron: "0 0 * * *" jobs: stale: @@ -17,8 +17,8 @@ jobs: stale-pr-message: | Thank you for opening this pull request. It appears that a request for e.g. information has not yet been completed. Therefore this issue will be automatically closed in 7 days, assuming that the proposed change is no longer required or has otherwise been resolved. - stale-issue-label: 'stale' - stale-pr-label: 'stale' - only-labels: 'needs more info' + stale-issue-label: "stale" + stale-pr-label: "stale" + only-labels: "needs more info" days-before-stale: 7 days-before-close: 7 diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index 34d7809..df862b3 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -6,10 +6,10 @@ on: # action is triggered on push to the following paths push: paths: - - 'templates/**' - - 'scripts/sync*' - - 'package.json' - - '.github/workflows/sync.yml' + - "templates/**" + - "scripts/sync*" + - "package.json" + - ".github/workflows/sync.yml" branches: - master diff --git a/.github/workflows/text-run.yml b/.github/workflows/text-run.yml index 858217d..26fe38b 100644 --- a/.github/workflows/text-run.yml +++ b/.github/workflows/text-run.yml @@ -16,6 +16,6 @@ jobs: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: - node-version: '15' + node-version: "15" - run: npm ci - run: npm run text-run diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..c596dc2 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,3 @@ +saved_replies +templates/repository/library/.github +templates/repository/server/.github diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f9ab1ec..2351896 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,14 +2,17 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation -in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, -sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and +expression, level of experience, education, socio-economic status, nationality, +personal appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment include: +Examples of behavior that contributes to creating a positive environment +include: - Using welcoming and inclusive language - Being respectful of differing viewpoints and experiences @@ -19,43 +22,56 @@ Examples of behavior that contributes to creating a positive environment include Examples of unacceptable behavior by participants include: -- The use of sexualized language or imagery and unwelcome sexual attention or advances +- The use of sexualized language or imagery and unwelcome sexual attention or + advances - Trolling, insulting/derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and -fair corrective action in response to any instances of unacceptable behavior. +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and -other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other -behaviors that they deem inappropriate, threatening, offensive, or harmful. +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, +offensive, or harmful. ## Scope -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its -community. Examples of representing a project or community include using an official project e-mail address, posting via an -official social media account, or acting as an appointed representative at an online or offline event. Representation of a project -may be further defined and clarified by project maintainers. +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at -office@ory.sh. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and -appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an -incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at office@ory.sh. All complaints will be +reviewed and investigated and will result in a response that is deemed necessary +and appropriate to the circumstances. The project team is obligated to maintain +confidentiality with regard to the reporter of an incident. Further details of +specific enforcement policies may be posted separately. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions -as determined by other members of the project's leadership. +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org -For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2573cb7..1d7fae9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,35 +29,46 @@ https://github.com/ory/meta/blob/master/templates/repository/CONTRIBUTING.md ## Introduction -There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level -overview of how you can get involved. +There are many ways in which you can contribute, beyond writing code. The goal +of this document is to provide a high-level overview of how you can get +involved. -_Please note_: We take ORY {{Project}}'s security and our users' trust very seriously. If you believe you have found a security -issue in ORY {{Project}}, please responsibly disclose by contacting us at security@ory.sh. +_Please note_: We take ORY {{Project}}'s security and our users' trust very +seriously. If you believe you have found a security issue in ORY {{Project}}, +please responsibly disclose by contacting us at security@ory.sh. -First: As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and -holidays. Please do not ever hesitate to ask a question or send a pull request. +First: As a potential contributor, your changes and ideas are welcome at any +hour of the day or night, weekdays, weekends, and holidays. Please do not ever +hesitate to ask a question or send a pull request. -If you are unsure, just ask or submit the issue or pull request anyways. You won't be yelled at for giving it your best effort. -The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't -want a wall of rules to get in the way of that. +If you are unsure, just ask or submit the issue or pull request anyways. You +won't be yelled at for giving it your best effort. The worst that can happen is +that you'll be politely asked to change something. We appreciate any sort of +contributions, and don't want a wall of rules to get in the way of that. -That said, if you want to ensure that a pull request is likely to be merged, talk to us! You can find out our thoughts and ensure -that your contribution won't clash or be obviated by ORY {{Project}}'s normal direction. A great way to do this is via the -[ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat). +That said, if you want to ensure that a pull request is likely to be merged, +talk to us! You can find out our thoughts and ensure that your contribution +won't clash or be obviated by ORY {{Project}}'s normal direction. A great way to +do this is via the [ORY Community](https://community.ory.sh/) or join the +[ORY Chat](https://www.ory.sh/chat). ## FAQ -- I am new to the community. Where can I find the [ORY Community Code of Conduct?](CODE_OF_CONDUCT.md) +- I am new to the community. Where can I find the + [ORY Community Code of Conduct?](CODE_OF_CONDUCT.md) -- I have a question. Where can I get [answers to questions regarding ORY {{Project}}?](#communication) +- I have a question. Where can I get + [answers to questions regarding ORY {{Project}}?](#communication) -- I would like to contribute but I am not sure how. Are there [easy ways to contribute?](#how-can-i-contribute) +- I would like to contribute but I am not sure how. Are there + [easy ways to contribute?](#how-can-i-contribute) [Or good first issues?](https://github.com/search?l=&o=desc&q=label%3A%22help+wanted%22+label%3A%22good+first+issue%22+is%3Aopen+user%3Aory+user%3Aory-corp&s=updated&type=Issues) -- I want to talk to other ORY {{Project}} users. [How can I become a part of the community?](#communication) +- I want to talk to other ORY {{Project}} users. + [How can I become a part of the community?](#communication) -- I would like to know what I am agreeing to when I contribute to ORY {{Project}}. Does ORY have +- I would like to know what I am agreeing to when I contribute to ORY + {{Project}}. Does ORY have [a Contributors License Agreement?](https://cla-assistant.io/ory/) - I would like updates about new versions of ORY {{Project}}. @@ -68,98 +79,125 @@ that your contribution won't clash or be obviated by ORY {{Project}}'s normal di If you want to start contributing code right away, we have a [list of good first issues](https://github.com/ory/{{Project}}/labels/good%20first%20issue). -There are many other ways you can contribute without writing any code. Here are a few things you can do to help out: +There are many other ways you can contribute without writing any code. Here are +a few things you can do to help out: -- **Give us a star.** It may not seem like much, but it really makes a difference. This is something that everyone can do to help - out ORY {{Project}}. Github stars help the project gain visibility and stand out. +- **Give us a star.** It may not seem like much, but it really makes a + difference. This is something that everyone can do to help out ORY + {{Project}}. Github stars help the project gain visibility and stand out. -- **Join the community.** Sometimes helping people can be as easy as listening to their problems and offering a different - perspective. Join our Slack, have a look at discussions in the forum and take part in our weekly hangout. More info on this in - [Communication](#communication). +- **Join the community.** Sometimes helping people can be as easy as listening + to their problems and offering a different perspective. Join our Slack, have a + look at discussions in the forum and take part in our weekly hangout. More + info on this in [Communication](#communication). -- **Helping with open issues.** We have a lot of open issues for ORY {{Project}} and some of them may lack necessary information, - some are duplicates of older issues. You can help out by guiding people through the process of filling out the issue template, - asking for clarifying information, or pointing them to existing issues that match their description of the problem. +- **Helping with open issues.** We have a lot of open issues for ORY {{Project}} + and some of them may lack necessary information, some are duplicates of older + issues. You can help out by guiding people through the process of filling out + the issue template, asking for clarifying information, or pointing them to + existing issues that match their description of the problem. -- **Reviewing documentation changes.** Most documentation just needs a review for proper spelling and grammar. If you think a - document can be improved in any way, feel free to hit the `edit` button at the top of the page. More info on contributing to - documentation here. +- **Reviewing documentation changes.** Most documentation just needs a review + for proper spelling and grammar. If you think a document can be improved in + any way, feel free to hit the `edit` button at the top of the page. More info + on contributing to documentation here. -- **Help with tests.** Some pull requests may lack proper tests or test plans. These are needed for the change to be implemented - safely. +- **Help with tests.** Some pull requests may lack proper tests or test plans. + These are needed for the change to be implemented safely. ## Communication -We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to -other users of ORY, etc. +We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask +questions, discuss bugs and feature requests, talk to other users of ORY, etc. -We have a [forum](https://community.ory.sh/). This is a great place for in-depth discussions and lots of code examples, logs and -similar data. +We have a [forum](https://community.ory.sh/). This is a great place for in-depth +discussions and lots of code examples, logs and similar data. -You can also join our community hangout, if you want to speak to the ORY team directly or ask some questions. You can find more -info on the hangouts in [Slack](https://www.ory.sh/chat). +You can also join our community hangout, if you want to speak to the ORY team +directly or ask some questions. You can find more info on the hangouts in +[Slack](https://www.ory.sh/chat). -If you want to receive regular notifications about updates to ORY {{Project}}, consider joining the mailing list. We will _only_ -send you vital information on the projects that you are interested in. +If you want to receive regular notifications about updates to ORY {{Project}}, +consider joining the mailing list. We will _only_ send you vital information on +the projects that you are interested in. Also [follow us on twitter](https://twitter.com/orycorp). ## Contributing Code -Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or -[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with ORY {{Project}}'s roadmap and -architecture. +Unless you are fixing a known bug, we **strongly** recommend discussing it with +the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat) +before getting started to ensure your work is consistent with ORY {{Project}}'s +roadmap and architecture. -All contributions are made via pull request. Note that **all patches from all contributors get reviewed**. After a pull request is -made other contributors will offer feedback, and if the patch passes review a maintainer will accept it with a comment. When pull -requests fail testing, authors are expected to update their pull requests to address the failures until the tests pass and the -pull request merges successfully. Look here for more info on the [Pull request procedure](#pull-request-procedure). +All contributions are made via pull request. Note that **all patches from all +contributors get reviewed**. After a pull request is made other contributors +will offer feedback, and if the patch passes review a maintainer will accept it +with a comment. When pull requests fail testing, authors are expected to update +their pull requests to address the failures until the tests pass and the pull +request merges successfully. Look here for more info on the +[Pull request procedure](#pull-request-procedure). -At least one review from a maintainer is required for all patches (even patches from maintainers). +At least one review from a maintainer is required for all patches (even patches +from maintainers). -Before your contributions can be merged you need to sign our [Contributor License Agreement](https://cla-assistant.io/ory/). +Before your contributions can be merged you need to sign our +[Contributor License Agreement](https://cla-assistant.io/ory/). -This agreement defines the terms under which your code is contributed to ORY. More specifically it declares that you have the -right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our -projects are published [here](https://github.com/ory/meta/blob/master/LICENSE). +This agreement defines the terms under which your code is contributed to ORY. +More specifically it declares that you have the right to, and actually do, grant +us the rights to use your contribution. You can see the Apache 2.0 license under +which our projects are published +[here](https://github.com/ory/meta/blob/master/LICENSE). -Reviewers should leave a "LGTM" comment once they are satisfied with the patch. If the patch was submitted by a maintainer with -write access, the pull request should be merged by the submitter after review. +Reviewers should leave a "LGTM" comment once they are satisfied with the patch. +If the patch was submitted by a maintainer with write access, the pull request +should be merged by the submitter after review. ## Documentation -Please provide documentation when changing, removing, or adding features. Documentation resides in the project's [docs](docs) -folder. Generate API and configuration reference documentation using `cd docs; npm run gen`. +Please provide documentation when changing, removing, or adding features. +Documentation resides in the project's [docs](docs) folder. Generate API and +configuration reference documentation using `cd docs; npm run gen`. For further instructions please head over to [docs/README.md](docs/README.md). ## Disclosing vulnerabilities -Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. +Please disclose vulnerabilities exclusively to +[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. ## Code Style Please follow these guidelines when formatting source code: - Go code should match the output of `gofmt -s` and pass `golangci-lint run`. -- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate. +- NodeJS and JavaScript code should be prettified using `npm run format` where + appropriate. ## Pull request procedure -To make a pull request, you will need a GitHub account; if you are unclear on this process, see GitHub's documentation on -[forking](https://help.github.com/articles/fork-a-repo) and [pull requests](https://help.github.com/articles/using-pull-requests). -Pull requests should be targeted at the `master` branch. Before creating a pull request, go through this checklist: +To make a pull request, you will need a GitHub account; if you are unclear on +this process, see GitHub's documentation on +[forking](https://help.github.com/articles/fork-a-repo) and +[pull requests](https://help.github.com/articles/using-pull-requests). Pull +requests should be targeted at the `master` branch. Before creating a pull +request, go through this checklist: 1. Create a feature branch off of `master` so that changes do not get mixed up. -1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch. -1. Run the full project test suite with the `go test ./...` (or equivalent) command and confirm that it passes. +1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local + changes against the `master` branch. +1. Run the full project test suite with the `go test ./...` (or equivalent) + command and confirm that it passes. 1. Run `gofmt -s` (if the project is written in Go). 1. Ensure that each commit has a subsystem prefix (ex: `controller:`). -Pull requests will be treated as "review requests," and maintainers will give feedback on the style and substance of the patch. +Pull requests will be treated as "review requests," and maintainers will give +feedback on the style and substance of the patch. -Normally, all pull requests must include tests that test your change. Occasionally, a change will be very difficult to test for. -In those cases, please include a note in your commit message explaining why. +Normally, all pull requests must include tests that test your change. +Occasionally, a change will be very difficult to test for. In those cases, +please include a note in your commit message explaining why. ### Working with Forks @@ -190,19 +228,25 @@ Now go to the project's GitHub Pull Request page and click "New pull request" ## Conduct -Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your -back. +Whether you are a regular contributor or a newcomer, we care about making this +community a safe place for you and we've got your back. -- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, - disability, ethnicity, religion, or similar personal characteristic. -- Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all. +- We are committed to providing a friendly, safe and welcoming environment for + all, regardless of gender, sexual orientation, disability, ethnicity, + religion, or similar personal characteristic. +- Please avoid using nicknames that might detract from a friendly, safe and + welcoming environment for all. - Be kind and courteous. There is no need to be mean or rude. -- We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate behavior that - excludes people in socially marginalized groups. -- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made - uncomfortable by a community member, please contact one of the channel ops or a member of the ORY {{Project}} core team - immediately. -- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome. - -We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, -feedback, or concerns [please let us know](https://www.ory.sh/chat). +- We will exclude you from interaction if you insult, demean or harass anyone. + In particular, we do not tolerate behavior that excludes people in socially + marginalized groups. +- Private harassment is also unacceptable. No matter who you are, if you feel + you have been or are being harassed or made uncomfortable by a community + member, please contact one of the channel ops or a member of the ORY + {{Project}} core team immediately. +- Likewise any spamming, trolling, flaming, baiting or other attention-stealing + behaviour is not welcome. + +We welcome discussion about creating a welcoming, safe, and productive +environment for the community. If you have any questions, feedback, or concerns +[please let us know](https://www.ory.sh/chat). diff --git a/README.md b/README.md index 9df7573..cca90b8 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,36 @@ # meta -A place for reusable code, templates, and documentation required for getting a repository in Ory working. +A place for reusable code, templates, and documentation required for getting a +repository in Ory working. ## Documentation ### Updating Templates -This repository contains templates for things like the software license, security policy, contributing guidelines, code of -conduct, and so on. +This repository contains templates for things like the software license, +security policy, contributing guidelines, code of conduct, and so on. -You can find the repository templates in [templates/repository](./templates/repository). Libraries (e.g. Dockertest) and servers -(e.g. Kratos) share templates from the [common](./templates/repository/common) directory. Additionally, servers copy files from -[server](./templates/repository/server) and libraries from the [library](./templates/repository/library) directory. +You can find the repository templates in +[templates/repository](./templates/repository). Libraries (e.g. Dockertest) and +servers (e.g. Kratos) share templates from the +[common](./templates/repository/common) directory. Additionally, servers copy +files from [server](./templates/repository/server) and libraries from the +[library](./templates/repository/library) directory. -To update the repositories simply make your changes. Once merged to master, they will be published using a GitHub Action. +To update the repositories simply make your changes. Once merged to master, they +will be published using a GitHub Action. ## Github Sync action -The [meta scripts](https://github.com/ory/meta/tree/master/scripts) serve to synchronize all Ory repositories to a common -template, including README, CONTRIBUTING, COC, SECURITY, LICENCE and Github Workflows with close to zero manual interaction. -Depending on repository type (server, library, action) specific templates can be copied as well. -The project names, links to documentation ect. are being substituted for each project in -[sync.sh](https://github.com/ory/meta/blob/master/scripts/sync.sh). -For more details please refer to the documentation within the [scripts](https://github.com/ory/meta/tree/master/scripts). For more -details on the workflow please refer to the documentation within +The [meta scripts](https://github.com/ory/meta/tree/master/scripts) serve to +synchronize all Ory repositories to a common template, including README, +CONTRIBUTING, COC, SECURITY, LICENCE and Github Workflows with close to zero +manual interaction. +Depending on repository type (server, library, action) specific templates can be +copied as well. +The project names, links to documentation ect. are being substituted for each +project in [sync.sh](https://github.com/ory/meta/blob/master/scripts/sync.sh). +For more details please refer to the documentation within the +[scripts](https://github.com/ory/meta/tree/master/scripts). For more details on +the workflow please refer to the documentation within [sync.yml](https://github.com/ory/meta/blob/master/.github/workflows/sync.yml) diff --git a/SECURITY.md b/SECURITY.md index 8152c97..70f1ef4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -21,8 +21,8 @@ https://github.com/ory/meta/blob/master/templates/repository/SECURITY.md ## Supported Versions -We release patches for security vulnerabilities. Which versions are eligible receiving such patches depend on the CVSS v3.0 -Rating: +We release patches for security vulnerabilities. Which versions are eligible +receiving such patches depend on the CVSS v3.0 Rating: | CVSS v3.0 | Supported Versions | | --------- | ----------------------------------------- | @@ -31,6 +31,7 @@ Rating: ## Reporting a Vulnerability -Please report (suspected) security vulnerabilities to **[security@ory.sh](mailto:security@ory.sh)**. You will receive a response -from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but -historically within a few days. +Please report (suspected) security vulnerabilities to +**[security@ory.sh](mailto:security@ory.sh)**. You will receive a response from +us within 48 hours. If the issue is confirmed, we will release a patch as soon +as possible depending on complexity but historically within a few days. diff --git a/community_hangouts.md b/community_hangouts.md index 047c3c1..9d0548f 100644 --- a/community_hangouts.md +++ b/community_hangouts.md @@ -10,16 +10,17 @@ ### Answer -Write a pull request that submits the organizational structure that could be part of Keto. It might be easier to ask for all the -logic to be supported in Keto. +Write a pull request that submits the organizational structure that could be +part of Keto. It might be easier to ask for all the logic to be supported in +Keto. -Look if Keto can support what you are looking for and if it does not support that then make a feature request. Easier to pull off -outside of Kratos. +Look if Keto can support what you are looking for and if it does not support +that then make a feature request. Easier to pull off outside of Kratos. ### Answer -It should be possible, it should be a feature in Oathkeeper. If it is not possible please open a feature request; it is a very -common/good use case. +It should be possible, it should be a feature in Oathkeeper. If it is not +possible please open a feature request; it is a very common/good use case. --- @@ -31,8 +32,9 @@ common/good use case. ### Answer -That is definitely something we are looking at. We need to figure out how to implement this safely though. It will be a lot of -work but it would be a very important feature for us to have. +That is definitely something we are looking at. We need to figure out how to +implement this safely though. It will be a lot of work but it would be a very +important feature for us to have. --- @@ -54,14 +56,15 @@ work but it would be a very important feature for us to have. ### Answer -We have extensive documentation on any breaking changes, if you sign up to the newsletter you will get notified every time there -is a new release. +We have extensive documentation on any breaking changes, if you sign up to the +newsletter you will get notified every time there is a new release. -We have elaborate descriptions of all changes in the newsletter, or on github. The changelogs are in the documentation and also on -github. Also with guides how to do the upgrade/migration. +We have elaborate descriptions of all changes in the newsletter, or on github. +The changelogs are in the documentation and also on github. Also with guides how +to do the upgrade/migration. -With helm charts its a manual process changing the version number at the moment. We are looking to automate this in the near -future. +With helm charts its a manual process changing the version number at the moment. +We are looking to automate this in the near future. [k8s issue #180](https://github.com/ory/k8s/issues/180) @@ -73,15 +76,17 @@ future. #### Do you have plans to offer support the open source, selfhosted deployments? -We have been using Oathkeeper & Kratos for Auth. We are interested in support, but our customers dont allow SaaS in this regard. +We have been using Oathkeeper & Kratos for Auth. We are interested in support, +but our customers dont allow SaaS in this regard. ### Answer -We will focus on the cloud offering, it is easy to scale, easier to support. But this request comes often, and we do want to help -companies in this position. +We will focus on the cloud offering, it is easy to scale, easier to support. But +this request comes often, and we do want to help companies in this position. -We do want to offer solutions there so we could provide you with support in the future. Best solution: Talk to -[jared](mailto:jared@ory.sh), figure out what you need and we will find a solution. +We do want to offer solutions there so we could provide you with support in the +future. Best solution: Talk to [jared](mailto:jared@ory.sh), figure out what you +need and we will find a solution. --- @@ -91,13 +96,15 @@ We do want to offer solutions there so we could provide you with support in the #### Is there a config to have Hydra respond to /api/hydra for example? -I am deploying Hydra in Docker in AWS. I cant configure it to respond to a specific URL, without route URL. +I am deploying Hydra in Docker in AWS. I cant configure it to respond to a +specific URL, without route URL. ### Answer Solution here is reverse proxy, like Oathkeeper. -If you do not use a reverse proxy, you have to do it with path rewrite currently. +If you do not use a reverse proxy, you have to do it with path rewrite +currently. --- @@ -107,16 +114,18 @@ If you do not use a reverse proxy, you have to do it with path rewrite currently ### Answer -All projects that are currently open source, will remain open source. We have a commitment to open source, that we still need to -publish. +All projects that are currently open source, will remain open source. We have a +commitment to open source, that we still need to publish. -We will not go down the path of ElasticSearch. The monetization strategy that we are following is running all the software as one -consistent product with alot of additional benefits as a cloud service. +We will not go down the path of ElasticSearch. The monetization strategy that we +are following is running all the software as one consistent product with alot of +additional benefits as a cloud service. -But the core building blocks will remain free and open source. As we use Linux and Kubernetes, we also use the ORY stack - which -is open source. +But the core building blocks will remain free and open source. As we use Linux +and Kubernetes, we also use the ORY stack - which is open source. -We are also planning on having a foundation of sorts, but this is still in planning. +We are also planning on having a foundation of sorts, but this is still in +planning. --- @@ -124,8 +133,8 @@ We are also planning on having a foundation of sorts, but this is still in plann ### Comment -Next big assignment for Patrick is implementation of Google Sansibar paper. This will allow us to deploy multi-region without -significant latency. +Next big assignment for Patrick is implementation of Google Sansibar paper. This +will allow us to deploy multi-region without significant latency. --- @@ -141,14 +150,17 @@ significant latency. ### Answer by Aeneas -So the original hydrator was more or less like an interim solution for the project and the idea was always to have a pipeline -where you do authentication, hydration, authorization and then mutation. +So the original hydrator was more or less like an interim solution for the +project and the idea was always to have a pipeline where you do authentication, +hydration, authorization and then mutation. -So you've probably looked into the configuration system for remote Json, for example, and I think its ultimately really not great -to generate Json. So we want to use JsonNet for all of the config stuff. And with the change we would also introduce a new part to -the pipeline, which would then be a dedicated hydrator because I think it makes a lot of sense to add. Basically you get the -requests and then authenticate, add context, check for permissions and then you take all of the data, massage it and put it into a -token or something. +So you've probably looked into the configuration system for remote Json, for +example, and I think its ultimately really not great to generate Json. So we +want to use JsonNet for all of the config stuff. And with the change we would +also introduce a new part to the pipeline, which would then be a dedicated +hydrator because I think it makes a lot of sense to add. Basically you get the +requests and then authenticate, add context, check for permissions and then you +take all of the data, massage it and put it into a token or something. --- @@ -160,16 +172,19 @@ token or something. ### Answer -The way we do release is slow because the pipelines sometimes a little bit flaky when it comes to releases as we do pre-releases. -So we do for example the pre-release where we see if all the pipelines are working, if the build is successful and if all the -tests are successful for the build pipeline, the binary in a Docker image ect. +The way we do release is slow because the pipelines sometimes a little bit flaky +when it comes to releases as we do pre-releases. So we do for example the +pre-release where we see if all the pipelines are working, if the build is +successful and if all the tests are successful for the build pipeline, the +binary in a Docker image ect. -If that works and once that passes all tests we do the proper release. So the fact that you're seeing the pre dot 0 release is a -very good sign because it means that we're working on it. Unfortunately the build didn't pass so so we will be trying to figure -out what's going on. +If that works and once that passes all tests we do the proper release. So the +fact that you're seeing the pre dot 0 release is a very good sign because it +means that we're working on it. Unfortunately the build didn't pass so so we +will be trying to figure out what's going on. -You can expect the release maybe in the next hours, definitely this week. It depends how difficult it is to figure out what's -going on. +You can expect the release maybe in the next hours, definitely this week. It +depends how difficult it is to figure out what's going on. --- @@ -179,18 +194,22 @@ going on. #### Is there any way to specify the schema_id to render the proper form inputs which belong to the specified schema? -For example I have an employee and customer schema and I would like to be able to specify the schema when registering a new -account from the selfservice endpoints or public API or anywhere else where I can create a user. +For example I have an employee and customer schema and I would like to be able +to specify the schema when registering a new account from the selfservice +endpoints or public API or anywhere else where I can create a user. -More info in [this thread](https://community.ory.sh/t/multiple-schemas-identities-seem-problematic/2251) +More info in +[this thread](https://community.ory.sh/t/multiple-schemas-identities-seem-problematic/2251) ### Answer -So for registration, it's a little bit difficult because assume you have customer schema and you have a admin schema. You don't -really want someone who signs up to be able to use the admin schema because they're not a regular user or customer. +So for registration, it's a little bit difficult because assume you have +customer schema and you have a admin schema. You don't really want someone who +signs up to be able to use the admin schema because they're not a regular user +or customer. -I think the best idea probably would be to create an issue in the Kratos repo and explain the use case and then we can discuss -some ideas. +I think the best idea probably would be to create an issue in the Kratos repo +and explain the use case and then we can discuss some ideas. Connected Issue: [kratos #765](https://github.com/ory/kratos/issues/765) @@ -206,74 +225,93 @@ Connected Issue: [kratos #765](https://github.com/ory/kratos/issues/765) ### Question -We had to get used to the terminology and what all the different systems do because there's quite a lot to the ecosystem. Could -you give me a broad overview? +We had to get used to the terminology and what all the different systems do +because there's quite a lot to the ecosystem. Could you give me a broad +overview? ### Answer -We started out with Hydra, which is the protocol layer for open authorization and open ID connect. And the reason we started there -was that we were doing a cloud native file sharing application at the time and it just got really difficult to interface with -Dropbox and Google Cloud and so on. The Go Community was not so so big back then and we just wanted to do something that would be +We started out with Hydra, which is the protocol layer for open authorization +and open ID connect. And the reason we started there was that we were doing a +cloud native file sharing application at the time and it just got really +difficult to interface with Dropbox and Google Cloud and so on. The Go Community +was not so so big back then and we just wanted to do something that would be good for Go developers to use. -But the deeper you get into open authorization and OAuth and OpenID Connect the more complex it gets, the terminology, the -structure of things, the processes or flows. So we ended up completely redoing Hydra two times just because the more we got into -it, the more we knew and learned. - -Then probably the best place to start is with Kratos, which is how you build your credentials, your username, password and all the -flows around that. - -Alot of companies don't need auth and open ID connect because they're not using cloud native services. So here Kratos is a great -fit. I think it's really an amazing utility, that we're soon going to offer as a cloud service also, by the way. Then Hydra I just -explained that, and also we have oathkeeper. Oathkeeper is an implementation of Google beyondcorp reverse proxy plus some rules -about how and why to access API, so when you use Json web tokens against an API for OAuth, there's a number of rules etc. It could -be in the payload or it could be just general rules about API access that you want to implement, so that's a zero trust API access -infrastructure. - -And last but not least there are different models out there for role-based access management. For instance ORY Keto is an -implementation basically mimicking the AWS IAM. And now if you look at the newest sort of PR in the Keto project we are tackling -this at a much bigger level and implementing or trying to implement something that Google calls Zanzibar, which is a more sort of -very low latency access management and role-based control system. So you write the rules and we basically create an infrastructure -that lets you manage that at planet scale. +But the deeper you get into open authorization and OAuth and OpenID Connect the +more complex it gets, the terminology, the structure of things, the processes or +flows. So we ended up completely redoing Hydra two times just because the more +we got into it, the more we knew and learned. + +Then probably the best place to start is with Kratos, which is how you build +your credentials, your username, password and all the flows around that. + +Alot of companies don't need auth and open ID connect because they're not using +cloud native services. So here Kratos is a great fit. I think it's really an +amazing utility, that we're soon going to offer as a cloud service also, by the +way. Then Hydra I just explained that, and also we have oathkeeper. Oathkeeper +is an implementation of Google beyondcorp reverse proxy plus some rules about +how and why to access API, so when you use Json web tokens against an API for +OAuth, there's a number of rules etc. It could be in the payload or it could be +just general rules about API access that you want to implement, so that's a zero +trust API access infrastructure. + +And last but not least there are different models out there for role-based +access management. For instance ORY Keto is an implementation basically +mimicking the AWS IAM. And now if you look at the newest sort of PR in the Keto +project we are tackling this at a much bigger level and implementing or trying +to implement something that Google calls Zanzibar, which is a more sort of very +low latency access management and role-based control system. So you write the +rules and we basically create an infrastructure that lets you manage that at +planet scale. --- ### Question -We are reading that jobs in Kratos are not being encouraged anymore. Why is that? +We are reading that jobs in Kratos are not being encouraged anymore. Why is +that? ### Answer -The reason for that is it's Hydra uses a special flavor of jobs before you get to the API. The reason for that is to obfuscate -some information and also make it more compatible with some of the other security approaches we have including oathkeeper, but -when it's through the API it then turns into a normal Json web token. So these are Open Standards, but they give you a lot of, -let's say flexibility, especially on how you want to configure the payload. +The reason for that is it's Hydra uses a special flavor of jobs before you get +to the API. The reason for that is to obfuscate some information and also make +it more compatible with some of the other security approaches we have including +oathkeeper, but when it's through the API it then turns into a normal Json web +token. So these are Open Standards, but they give you a lot of, let's say +flexibility, especially on how you want to configure the payload. -nd they have a very simple structure, there's a record for how it's been made, what algorithm the payload uses and the signature -and we're not going to stray far away from that at all because that's how you guarantee interoperability amongst different -systems. So we do take some liberties within Hydra of making those tokens as it's called "ORY flavoured" until they get to the -API. +nd they have a very simple structure, there's a record for how it's been made, +what algorithm the payload uses and the signature and we're not going to stray +far away from that at all because that's how you guarantee interoperability +amongst different systems. So we do take some liberties within Hydra of making +those tokens as it's called "ORY flavoured" until they get to the API. -There's also some situations where it's not recommendable to use jobs. There's actually lots of situations just because it's a new -area and it's emerging. And you know, there is not enough implementation experience with it. +There's also some situations where it's not recommendable to use jobs. There's +actually lots of situations just because it's a new area and it's emerging. And +you know, there is not enough implementation experience with it. -So if you have architectural questions and you want to ask them, you can do that an issue or something else but be confident that -we've had tons of conversations about this and the implementation of Hydra is now over five years old. +So if you have architectural questions and you want to ask them, you can do that +an issue or something else but be confident that we've had tons of conversations +about this and the implementation of Hydra is now over five years old. --- ### Question -Our main fear is that you guys might be closing or changing all the Open Standards to some closed standard of security -authorization. +Our main fear is that you guys might be closing or changing all the Open +Standards to some closed standard of security authorization. ### Answer by Thomas -We're not interested in violating those standards actually in any way because that's the whole basis of our work too. I mean the -IEEE standard and the IETF standard and the w3c standard are our standards. That doesn't mean that the ORY projects implement -everything and by the way we implement a lot of things based on how companies are using these things, but when we implement it it -is exactly in accordance with the standard. And the ORY open source projects too are the codebase from that we build our products, -so we are relying on them to stay open source. +We're not interested in violating those standards actually in any way because +that's the whole basis of our work too. I mean the IEEE standard and the IETF +standard and the w3c standard are our standards. That doesn't mean that the ORY +projects implement everything and by the way we implement a lot of things based +on how companies are using these things, but when we implement it it is exactly +in accordance with the standard. And the ORY open source projects too are the +codebase from that we build our products, so we are relying on them to stay open +source. ## Comments diff --git a/package-lock.json b/package-lock.json index 0fe16dc..52ca7a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,9 +8,9 @@ "name": "meta", "version": "1.0.0", "devDependencies": { - "ory-prettier-styles": "1.2.0", - "prettier": "2.6.2", - "text-runner": "^5.0.0" + "ory-prettier-styles": "1.3.0", + "prettier": "2.7.1", + "text-runner": "5.0.1" } }, "node_modules/@babel/code-frame": { @@ -891,9 +891,9 @@ } }, "node_modules/ory-prettier-styles": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.2.0.tgz", - "integrity": "sha512-0kt+p6sy55XGtLkgcy4LC0vjOrRL3GbkJ8y95Ad7biguWWX/83w4N8ILFo0kJb8/CN9K4LuM51gsN5GdAuWcWg==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.3.0.tgz", + "integrity": "sha512-Vfn0G6CyLaadwcCamwe1SQCf37ZQfBDgMrhRI70dE/2fbE3Q43/xu7K5c32I5FGt/EliroWty5yBjmdkj0eWug==", "dev": true }, "node_modules/p-cancelable": { @@ -936,9 +936,9 @@ } }, "node_modules/prettier": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.6.2.tgz", - "integrity": "sha512-PkUpF+qoXTqhOeWL9fu7As8LXsIUZ1WYaJiY/a7McAQzxjk82OF0tibkFXVCDImZtWxbvojFjerkiLb0/q8mew==", + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz", + "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==", "dev": true, "bin": { "prettier": "bin-prettier.js" @@ -1965,9 +1965,9 @@ } }, "ory-prettier-styles": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.2.0.tgz", - "integrity": "sha512-0kt+p6sy55XGtLkgcy4LC0vjOrRL3GbkJ8y95Ad7biguWWX/83w4N8ILFo0kJb8/CN9K4LuM51gsN5GdAuWcWg==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.3.0.tgz", + "integrity": "sha512-Vfn0G6CyLaadwcCamwe1SQCf37ZQfBDgMrhRI70dE/2fbE3Q43/xu7K5c32I5FGt/EliroWty5yBjmdkj0eWug==", "dev": true }, "p-cancelable": { @@ -2004,9 +2004,9 @@ } }, "prettier": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.6.2.tgz", - "integrity": "sha512-PkUpF+qoXTqhOeWL9fu7As8LXsIUZ1WYaJiY/a7McAQzxjk82OF0tibkFXVCDImZtWxbvojFjerkiLb0/q8mew==", + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz", + "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==", "dev": true }, "ps-tree": { diff --git a/package.json b/package.json index 6183ec5..67e6b5a 100644 --- a/package.json +++ b/package.json @@ -15,8 +15,8 @@ "url": "git+https://github.com/ory/meta.git" }, "devDependencies": { - "ory-prettier-styles": "1.2.0", - "prettier": "2.6.2", + "ory-prettier-styles": "1.3.0", + "prettier": "2.7.1", "text-runner": "5.0.1" } } diff --git a/releases/kratos/0.5.0-alpha.1.md b/releases/kratos/0.5.0-alpha.1.md index 7c14d95..a0de707 100644 --- a/releases/kratos/0.5.0-alpha.1.md +++ b/releases/kratos/0.5.0-alpha.1.md @@ -1,12 +1,15 @@ Live long and prosper! -The ORY team and the fabulous ORY Community is proud to present the next ORY Kratos iteration! +The ORY team and the fabulous ORY Community is proud to present the next ORY +Kratos iteration! -ORY Kratos is now capable of handling native iOS, Android, Windows, and macOS login, registration, settings, recovery, and -verification flows. And there is a reference React Native application that you can find on +ORY Kratos is now capable of handling native iOS, Android, Windows, and macOS +login, registration, settings, recovery, and verification flows. And there is a +reference React Native application that you can find on [GitHub](http://github.com/ory/kratos-selfservice-ui-react-native). -We co-released our reference React Native application which acts as a reference on implementing these flows: +We co-released our reference React Native application which acts as a reference +on implementing these flows: ![Registration](http://ory.sh/images/newsletter/kratos-0.5.0/registration-screen.png) @@ -14,52 +17,70 @@ We co-released our reference React Native application which acts as a reference ![Settings](http://ory.sh/images/newsletter/kratos-0.5.0/settings-screen.png) -In total, almost 1200 files were changed in about 480 commits. WOW! While you can find a list of all changes in the changelist -below, the following are the features we are proud of: +In total, almost 1200 files were changed in about 480 commits. WOW! While you +can find a list of all changes in the changelist below, the following are the +features we are proud of: -- We renamed login, registration, ... requests to "flows" consistently across the code base, APIs, and data storage: +- We renamed login, registration, ... requests to "flows" consistently across + the code base, APIs, and data storage: - Initiate a login, registration, ... flow; - Fetch a login, registration, ... flow; and - - Complete a login, registration, ... flow using a login flow method such as "Log in with username and password". + - Complete a login, registration, ... flow using a login flow method such as + "Log in with username and password". -- All self-service flows are now capable of handling API-based requests that do not originate from browsers such as Chrome. This - is set groundwork for handling native flows named above! +- All self-service flows are now capable of handling API-based requests that do + not originate from browsers such as Chrome. This is set groundwork for + handling native flows named above! -- The self service documentation has been refactored and simplified. We added code samples, screenshots, payloads, and curl - commands to make things easier and clearer to understand. There are new video guides to help the community get things done - faster! Just slam that like button please! +- The self service documentation has been refactored and simplified. We added + code samples, screenshots, payloads, and curl commands to make things easier + and clearer to understand. There are new video guides to help the community + get things done faster! Just slam that like button please! -- We added documentation for rotating important secrets such as the cookie and session secrets. +- We added documentation for rotating important secrets such as the cookie and + session secrets. -- We removed the need for reverse proxies by adding the ability to change the ORY Kratos Session Cookie domain and path! The - [kratos-selfservice-ui-node](https://github.com/ory/kratos-selfservice-ui-node) reference implementation no longer requires HTTP - Request piping which greatly simplifies the network layout and codebase! +- We removed the need for reverse proxies by adding the ability to change the + ORY Kratos Session Cookie domain and path! The + [kratos-selfservice-ui-node](https://github.com/ory/kratos-selfservice-ui-node) + reference implementation no longer requires HTTP Request piping which greatly + simplifies the network layout and codebase! -- The ORY Kratos CLI is now capable of managing identities with an interface that works almost like the much loved Docker CLI! +- The ORY Kratos CLI is now capable of managing identities with an interface + that works almost like the much loved Docker CLI! - Admins can now initiate account recovery for identities. -- We even refactored Email verification and account recovery. It is now possible to add additional strategies e.g. recovery codes - in the future, greatly increasing the feature set and security capabilities of future ORY Kratos versions! +- We even refactored Email verification and account recovery. It is now possible + to add additional strategies e.g. recovery codes in the future, greatly + increasing the feature set and security capabilities of future ORY Kratos + versions! -- Lookup to 'Have I Been Pwnd' is no longer a hard requirement, allowing registration processes to complete when the service is - unavailable or the network is slow. +- Lookup to 'Have I Been Pwnd' is no longer a hard requirement, allowing + registration processes to complete when the service is unavailable or the + network is slow. -- We contributed several issues and features in upstream projects such as justinas/nosurf, gobuffalo/pop, and many more! +- We contributed several issues and features in upstream projects such as + justinas/nosurf, gobuffalo/pop, and many more! -- We upgraded the automation and build pipeline to support cross-compilation of CGO with Go 1.15+. +- We upgraded the automation and build pipeline to support cross-compilation of + CGO with Go 1.15+. -- Fetching flows no longer requires CSRF cookies to be set, improving the developer experience while not compromising security! +- Fetching flows no longer requires CSRF cookies to be set, improving the + developer experience while not compromising security! -- ORY Kratos now has ORY Kratos Session Cookies that set in the HTTP Cookie header, and ORY Kratos Session Tokens that are set as - a HTTP Bearer Authorization token or the `X-Session-Token` HTTP Header. +- ORY Kratos now has ORY Kratos Session Cookies that set in the HTTP Cookie + header, and ORY Kratos Session Tokens that are set as a HTTP Bearer + Authorization token or the `X-Session-Token` HTTP Header. -Additionally we just exterminated tons of bugs, added tests, improved documentation, and much much more. Please note that the cost -of all this innovation and collaboration is breaking changes. The details for the individual breaking changes is the changelog -below. +Additionally we just exterminated tons of bugs, added tests, improved +documentation, and much much more. Please note that the cost of all this +innovation and collaboration is breaking changes. The details for the individual +breaking changes is the changelog below. -We would like to thank all ORY Community members who contributed towards this release (in no particular order): +We would like to thank all ORY Community members who contributed towards this +release (in no particular order): - [kevgo](https://github.com/kevgo) - [NickUfer](https://github.com/NickUfer) @@ -75,6 +96,7 @@ We would like to thank all ORY Community members who contributed towards this re - [aschepis](https://github.com/aschepis) - [jakhog](https://github.com/jakhog) -Have fun exploring the new release. We hope you like it! If you haven't already, join the -[ORY Community Slack](http://slack.ory.sh) where we hold weekly community hangouts via video chat and answer your questions, -exchange ideas, and present new developments! +Have fun exploring the new release. We hope you like it! If you haven't already, +join the [ORY Community Slack](http://slack.ory.sh) where we hold weekly +community hangouts via video chat and answer your questions, exchange ideas, and +present new developments! diff --git a/saved_replies/circleci-blocking-merge.md b/saved_replies/circleci-blocking-merge.md index e1a7929..04029ae 100644 --- a/saved_replies/circleci-blocking-merge.md +++ b/saved_replies/circleci-blocking-merge.md @@ -1,5 +1,4 @@ -Unfortunately, for some reason, the CircleCI tests are not running. Do you maybe follow your/a fork of this repository on -CircleCI? If so, you need to unsubscribe / unwatch from that CircleCI project. Then, make another push to your branch using: +Unfortunately, for some reason, the CircleCI tests are not running. Do you maybe follow your/a fork of this repository on CircleCI? If so, you need to unsubscribe / unwatch from that CircleCI project. Then, make another push to your branch using: ``` $ git commit --amend --allow-empty diff --git a/saved_replies/cla-wrong-e-mail.md b/saved_replies/cla-wrong-e-mail.md index d95186f..a3c6367 100644 --- a/saved_replies/cla-wrong-e-mail.md +++ b/saved_replies/cla-wrong-e-mail.md @@ -4,8 +4,7 @@ Thank you, this looks great! It looks like the CLA bot is not properly detecting $ git commit --amend --author="Author Name " ``` -Ensure that `Author Name` is replaced with your GitHub username (e.g. `aeneasr`) and that the email address is replaced with the -email address you have set up in GitHub (e.g. `3372410+aeneasr@users.noreply.github.com`): +Ensure that `Author Name` is replaced with your GitHub username (e.g. `aeneasr`) and that the email address is replaced with the email address you have set up in GitHub (e.g. `3372410+aeneasr@users.noreply.github.com`): ``` $ git commit --amend --author="aeneasr <3372410+aeneasr@users.noreply.github.com>" diff --git a/saved_replies/docs-update-all-versions.md b/saved_replies/docs-update-all-versions.md index a358070..2201680 100644 --- a/saved_replies/docs-update-all-versions.md +++ b/saved_replies/docs-update-all-versions.md @@ -1,5 +1,4 @@ -Thank you very much for your contribution to the documentation! Due to the way [Docusaurus](https://docusaurus.io) versioning -works, you need to make the changes in two locations: +Thank you very much for your contribution to the documentation! Due to the way [Docusaurus](https://docusaurus.io) versioning works, you need to make the changes in two locations: - `docs/versioned_docs/version-v{version}/path/to/file` - `docs/docs/path/to/file` diff --git a/saved_replies/mark-as-draft.md b/saved_replies/mark-as-draft.md index 33195bc..fdac93f 100644 --- a/saved_replies/mark-as-draft.md +++ b/saved_replies/mark-as-draft.md @@ -1,6 +1,5 @@ While the PR is being worked on I will mark it as a draft. That declutters our review backlog :) -Once you're done with your changes and would like someone to review them, mark the PR as ready and request a review from one of -the maintainers. +Once you're done with your changes and would like someone to review them, mark the PR as ready and request a review from one of the maintainers. Thank you! diff --git a/saved_replies/not-using-issue-template.md b/saved_replies/not-using-issue-template.md index edea528..03b92e2 100644 --- a/saved_replies/not-using-issue-template.md +++ b/saved_replies/not-using-issue-template.md @@ -1,17 +1,12 @@ Thank you for contributing to this repository by creating an issue! -Unfortunately, your issue lacks vital information, such as log files, the error message, the software version, your configuration -or other pieces of the puzzle. +Unfortunately, your issue lacks vital information, such as log files, the error message, the software version, your configuration or other pieces of the puzzle. -Please also ensure that your issue is appropriately formatted. If you do not know how to write markdown, you can find help -[here](https://guides.github.com/features/mastering-markdown/). +Please also ensure that your issue is appropriately formatted. If you do not know how to write markdown, you can find help [here](https://guides.github.com/features/mastering-markdown/). -Helping you with your problem is only possible if you share this information, and it will save a lot of time of back and forth on -your as well as our end! +Helping you with your problem is only possible if you share this information, and it will save a lot of time of back and forth on your as well as our end! -For this reason, this repository uses [issue templates](../tree/master/.github/ISSUE_TEMPLATE) which you can select when pressing -"New issue". Please use one of those issue templates to fill in the required information. You can either create a new issue for -this purpose and close this one, or leave a comment. +For this reason, this repository uses [issue templates](../tree/master/.github/ISSUE_TEMPLATE) which you can select when pressing "New issue". Please use one of those issue templates to fill in the required information. You can either create a new issue for this purpose and close this one, or leave a comment. > Do not edit the original post as we will not be notified when you do so. diff --git a/templates/repository/action/.github/workflows/release_tagger.yml b/templates/repository/action/.github/workflows/release_tagger.yml index f37d4ad..11eb443 100644 --- a/templates/repository/action/.github/workflows/release_tagger.yml +++ b/templates/repository/action/.github/workflows/release_tagger.yml @@ -10,6 +10,6 @@ jobs: steps: - uses: Actions-R-Us/actions-tagger@latest env: - GITHUB_TOKEN: '${{ github.token }}' + GITHUB_TOKEN: "${{ github.token }}" with: publish_latest_tag: true diff --git a/templates/repository/common/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/templates/repository/common/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 8f5222e..a3458f2 100644 --- a/templates/repository/common/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/templates/repository/common/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -1,17 +1,17 @@ -description: 'Create a bug report' +description: "Create a bug report" labels: - bug -name: 'Bug Report' +name: "Bug Report" body: - attributes: value: "Thank you for taking the time to fill out this bug report!\n" type: markdown - attributes: - label: 'Preflight checklist' + label: "Preflight checklist" options: - label: - 'I could not find a solution in the existing issues, docs, nor - discussions.' + "I could not find a solution in the existing issues, docs, nor + discussions." required: true - label: "I agree to follow this project's [Code of @@ -22,18 +22,18 @@ body: Guidelines](https://github.com/$REPOSITORY/blob/master/CONTRIBUTING.md)." required: true - label: - 'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' + "This issue affects my [Ory Cloud](https://www.ory.sh/) project." - label: - 'I have joined the [Ory Community Slack](https://slack.ory.sh).' + "I have joined the [Ory Community Slack](https://slack.ory.sh)." - label: - 'I am signed up to the [Ory Security Patch - Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' + "I am signed up to the [Ory Security Patch + Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)." id: checklist type: checkboxes - attributes: - description: 'A clear and concise description of what the bug is.' - label: 'Describe the bug' - placeholder: 'Tell us what you see!' + description: "A clear and concise description of what the bug is." + label: "Describe the bug" + placeholder: "Tell us what you see!" id: describe-bug type: textarea validations: @@ -47,17 +47,17 @@ body: 1. Run `docker run ....` 2. Make API Request to with `curl ...` 3. Request fails with response: `{"some": "error"}` - label: 'Reproducing the bug' + label: "Reproducing the bug" id: reproduce-bug type: textarea validations: required: true - attributes: description: - 'Please copy and paste any relevant log output. This will be + "Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. Please - redact any sensitive information' - label: 'Relevant log output' + redact any sensitive information" + label: "Relevant log output" render: shell placeholder: | log=error .... @@ -65,10 +65,10 @@ body: type: textarea - attributes: description: - 'Please copy and paste any relevant configuration. This will be + "Please copy and paste any relevant configuration. This will be automatically formatted into code, so no need for backticks. Please - redact any sensitive information!' - label: 'Relevant configuration' + redact any sensitive information!" + label: "Relevant configuration" render: yml placeholder: | server: @@ -77,14 +77,14 @@ body: id: config type: textarea - attributes: - description: 'What version of our software are you running?' + description: "What version of our software are you running?" label: Version id: version type: input validations: required: true - attributes: - label: 'On which operating system are you observing this issue?' + label: "On which operating system are you observing this issue?" options: - Ory Cloud - macOS @@ -95,19 +95,19 @@ body: id: operating-system type: dropdown - attributes: - label: 'In which environment are you deploying?' + label: "In which environment are you deploying?" options: - Ory Cloud - Docker - - 'Docker Compose' - - 'Kubernetes with Helm' + - "Docker Compose" + - "Kubernetes with Helm" - Kubernetes - Binary - Other id: deployment type: dropdown - attributes: - description: 'Add any other context about the problem here.' + description: "Add any other context about the problem here." label: Additional Context id: additional type: textarea diff --git a/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml b/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml index 309d1d7..e657ee7 100644 --- a/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml +++ b/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml @@ -1,8 +1,8 @@ description: - 'A design document is needed for non-trivial changes to the code base.' + "A design document is needed for non-trivial changes to the code base." labels: - rfc -name: 'Design Document' +name: "Design Document" body: - attributes: value: | @@ -18,11 +18,11 @@ body: after code reviews, and your pull requests will be merged faster. type: markdown - attributes: - label: 'Preflight checklist' + label: "Preflight checklist" options: - label: - 'I could not find a solution in the existing issues, docs, nor - discussions.' + "I could not find a solution in the existing issues, docs, nor + discussions." required: true - label: "I agree to follow this project's [Code of @@ -33,18 +33,18 @@ body: Guidelines](https://github.com/$REPOSITORY/blob/master/CONTRIBUTING.md)." required: true - label: - 'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' + "This issue affects my [Ory Cloud](https://www.ory.sh/) project." - label: - 'I have joined the [Ory Community Slack](https://slack.ory.sh).' + "I have joined the [Ory Community Slack](https://slack.ory.sh)." - label: - 'I am signed up to the [Ory Security Patch - Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' + "I am signed up to the [Ory Security Patch + Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)." id: checklist type: checkboxes - attributes: description: | This section gives the reader a very rough overview of the landscape in which the new system is being built and what is actually being built. This isn’t a requirements doc. Keep it succinct! The goal is that readers are brought up to speed but some previous knowledge can be assumed and detailed info can be linked to. This section should be entirely focused on objective background facts. - label: 'Context and scope' + label: "Context and scope" id: scope type: textarea validations: @@ -53,7 +53,7 @@ body: - attributes: description: | A short list of bullet points of what the goals of the system are, and, sometimes more importantly, what non-goals are. Note, that non-goals aren’t negated goals like “The system shouldn’t crash”, but rather things that could reasonably be goals, but are explicitly chosen not to be goals. A good example would be “ACID compliance”; when designing a database, you’d certainly want to know whether that is a goal or non-goal. And if it is a non-goal you might still select a solution that provides it, if it doesn’t introduce trade-offs that prevent achieving the goals. - label: 'Goals and non-goals' + label: "Goals and non-goals" id: goals type: textarea validations: @@ -65,7 +65,7 @@ body: The design doc is the place to write down the trade-offs you made in designing your software. Focus on those trade-offs to produce a useful document with long-term value. That is, given the context (facts), goals and non-goals (requirements), the design doc is the place to suggest solutions and show why a particular solution best satisfies those goals. The point of writing a document over a more formal medium is to provide the flexibility to express the problem set at hand in an appropriate manner. Because of this, there is no explicit guidance for how to actually describe the design. - label: 'The design' + label: "The design" id: design type: textarea validations: @@ -74,21 +74,21 @@ body: - attributes: description: | If the system under design exposes an API, then sketching out that API is usually a good idea. In most cases, however, one should withstand the temptation to copy-paste formal interface or data definitions into the doc as these are often verbose, contain unnecessary detail and quickly get out of date. Instead focus on the parts that are relevant to the design and its trade-offs. - label: 'APIs' + label: "APIs" id: apis type: textarea - attributes: description: | Systems that store data should likely discuss how and in what rough form this happens. Similar to the advice on APIs, and for the same reasons, copy-pasting complete schema definitions should be avoided. Instead focus on the parts that are relevant to the design and its trade-offs. - label: 'Data storage' + label: "Data storage" id: persistence type: textarea - attributes: description: | Design docs should rarely contain code, or pseudo-code except in situations where novel algorithms are described. As appropriate, link to prototypes that show the implementability of the design. - label: 'Code and pseudo-code' + label: "Code and pseudo-code" id: pseudocode type: textarea @@ -101,7 +101,7 @@ body: On the other end are systems where the possible solutions are very well defined, but it isn’t at all obvious how they could even be combined to achieve the goals. This may be a legacy system that is difficult to change and wasn’t designed to do what you want it to do or a library design that needs to operate within the constraints of the host programming language. In this situation you may be able to enumerate all the things you can do relatively easily, but you need to creatively put those things together to achieve the goals. There may be multiple solutions, and none of them are really great, and hence such a document should focus on selecting the best way given all identified trade-offs. - label: 'Degree of constraint' + label: "Degree of constraint" id: constrait type: textarea diff --git a/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index e173ba2..0e48be3 100644 --- a/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -1,8 +1,8 @@ description: - 'Suggest an idea for this project without a plan for implementation' + "Suggest an idea for this project without a plan for implementation" labels: - feat -name: 'Feature Request' +name: "Feature Request" body: - attributes: value: | @@ -11,11 +11,11 @@ body: If you already have a plan to implement a feature or a change, please create a [design document](https://github.com/aeneasr/gh-template-test/issues/new?assignees=&labels=rfc&template=DESIGN-DOC.yml) instead if the change is non-trivial! type: markdown - attributes: - label: 'Preflight checklist' + label: "Preflight checklist" options: - label: - 'I could not find a solution in the existing issues, docs, nor - discussions.' + "I could not find a solution in the existing issues, docs, nor + discussions." required: true - label: "I agree to follow this project's [Code of @@ -26,18 +26,18 @@ body: Guidelines](https://github.com/$REPOSITORY/blob/master/CONTRIBUTING.md)." required: true - label: - 'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' + "This issue affects my [Ory Cloud](https://www.ory.sh/) project." - label: - 'I have joined the [Ory Community Slack](https://slack.ory.sh).' + "I have joined the [Ory Community Slack](https://slack.ory.sh)." - label: - 'I am signed up to the [Ory Security Patch - Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' + "I am signed up to the [Ory Security Patch + Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)." id: checklist type: checkboxes - attributes: description: - 'Is your feature request related to a problem? Please describe.' - label: 'Describe your problem' + "Is your feature request related to a problem? Please describe." + label: "Describe your problem" placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" @@ -50,20 +50,20 @@ body: Describe the solution you'd like placeholder: | A clear and concise description of what you want to happen. - label: 'Describe your ideal solution' + label: "Describe your ideal solution" id: solution type: textarea validations: required: true - attributes: description: "Describe alternatives you've considered" - label: 'Workarounds or alternatives' + label: "Workarounds or alternatives" id: alternatives type: textarea validations: required: true - attributes: - description: 'What version of our software are you running?' + description: "What version of our software are you running?" label: Version id: version type: input @@ -71,7 +71,7 @@ body: required: true - attributes: description: - 'Add any other context or screenshots about the feature request here.' + "Add any other context or screenshots about the feature request here." label: Additional Context id: additional type: textarea diff --git a/templates/repository/common/.github/config.yml b/templates/repository/common/.github/config.yml index 0d121fe..ea33569 100644 --- a/templates/repository/common/.github/config.yml +++ b/templates/repository/common/.github/config.yml @@ -1,3 +1,3 @@ todo: - keyword: '@todo' + keyword: "@todo" label: todo diff --git a/templates/repository/common/.github/workflows/closed_references.yml b/templates/repository/common/.github/workflows/closed_references.yml index ebafc8a..2789ac4 100644 --- a/templates/repository/common/.github/workflows/closed_references.yml +++ b/templates/repository/common/.github/workflows/closed_references.yml @@ -2,13 +2,13 @@ name: Closed Reference Notifier on: schedule: - - cron: '0 0 * * *' + - cron: "0 0 * * *" workflow_dispatch: inputs: issueLimit: description: Max. number of issues to create required: true - default: '5' + default: "5" jobs: find_closed_references: @@ -19,7 +19,7 @@ jobs: - uses: actions/checkout@v2 - uses: actions/setup-node@v2-beta with: - node-version: '14' + node-version: "14" - uses: ory/closed-reference-notifier@v1 with: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/templates/repository/common/.github/workflows/stale.yml b/templates/repository/common/.github/workflows/stale.yml index 395cb69..eb36db1 100644 --- a/templates/repository/common/.github/workflows/stale.yml +++ b/templates/repository/common/.github/workflows/stale.yml @@ -1,8 +1,8 @@ -name: 'Close Stale Issues' +name: "Close Stale Issues" on: workflow_dispatch: schedule: - - cron: '0 0 * * *' + - cron: "0 0 * * *" jobs: stale: @@ -35,10 +35,10 @@ jobs: Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you! Thank you 🙏✌️ - stale-issue-label: 'stale' - exempt-issue-labels: 'bug,blocking,docs,backlog' + stale-issue-label: "stale" + exempt-issue-labels: "bug,blocking,docs,backlog" days-before-stale: 365 days-before-close: 30 exempt-milestones: true exempt-assignees: true - only-pr-labels: 'stale' + only-pr-labels: "stale" diff --git a/templates/repository/common/ADOPTERS.md b/templates/repository/common/ADOPTERS.md index 5428946..d109c0d 100644 --- a/templates/repository/common/ADOPTERS.md +++ b/templates/repository/common/ADOPTERS.md @@ -1,16 +1,20 @@ -The Ory community stands on the shoulders of individuals, companies, and maintainers. We thank everyone involved - from submitting -bug reports and feature requests, to contributing patches, to sponsoring our work. Our community is 1000+ strong and growing -rapidly. The Ory stack protects 16.000.000.000+ API requests every month with over 250.000+ active service nodes. We would have +The Ory community stands on the shoulders of individuals, companies, and +maintainers. We thank everyone involved - from submitting bug reports and +feature requests, to contributing patches, to sponsoring our work. Our community +is 1000+ strong and growing rapidly. The Ory stack protects 16.000.000.000+ API +requests every month with over 250.000+ active service nodes. We would have never been able to achieve this without each and everyone of you! -The following list represents companies that have accompanied us along the way and that have made outstanding contributions to our -ecosystem. _If you think that your company deserves a spot here, reach out to +The following list represents companies that have accompanied us along the way +and that have made outstanding contributions to our ecosystem. _If you think +that your company deserves a spot here, reach out to office-muc@ory.sh now_! -**Please consider giving back by becoming a sponsor of our open source work on Patreon -or Open Collective.** +**Please consider giving back by becoming a sponsor of our open source work on +Patreon or +Open Collective.** @@ -177,8 +181,10 @@ as well as all of our backers -and past & current supporters (in alphabetical order) on [Patreon](https://www.patreon.com/_ory): Alexander Alimovs, Billy, Chancy -Kennedy, Drozzy, Edwin Trejos, Howard Edidin, Ken Adler Oz Haven, Stefan Hans, TheCrealm. +and past & current supporters (in alphabetical order) on +[Patreon](https://www.patreon.com/_ory): Alexander Alimovs, Billy, Chancy +Kennedy, Drozzy, Edwin Trejos, Howard Edidin, Ken Adler Oz Haven, Stefan Hans, +TheCrealm. \* Uses one of Ory's major projects in production. diff --git a/templates/repository/common/CODE_OF_CONDUCT.md b/templates/repository/common/CODE_OF_CONDUCT.md index f9ab1ec..2351896 100644 --- a/templates/repository/common/CODE_OF_CONDUCT.md +++ b/templates/repository/common/CODE_OF_CONDUCT.md @@ -2,14 +2,17 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation -in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, -sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and +expression, level of experience, education, socio-economic status, nationality, +personal appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment include: +Examples of behavior that contributes to creating a positive environment +include: - Using welcoming and inclusive language - Being respectful of differing viewpoints and experiences @@ -19,43 +22,56 @@ Examples of behavior that contributes to creating a positive environment include Examples of unacceptable behavior by participants include: -- The use of sexualized language or imagery and unwelcome sexual attention or advances +- The use of sexualized language or imagery and unwelcome sexual attention or + advances - Trolling, insulting/derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and -fair corrective action in response to any instances of unacceptable behavior. +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and -other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other -behaviors that they deem inappropriate, threatening, offensive, or harmful. +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, +offensive, or harmful. ## Scope -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its -community. Examples of representing a project or community include using an official project e-mail address, posting via an -official social media account, or acting as an appointed representative at an online or offline event. Representation of a project -may be further defined and clarified by project maintainers. +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at -office@ory.sh. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and -appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an -incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at office@ory.sh. All complaints will be +reviewed and investigated and will result in a response that is deemed necessary +and appropriate to the circumstances. The project team is obligated to maintain +confidentiality with regard to the reporter of an incident. Further details of +specific enforcement policies may be posted separately. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions -as determined by other members of the project's leadership. +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org -For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/templates/repository/common/CONTRIBUTING.md b/templates/repository/common/CONTRIBUTING.md index 950792f..c57b0b2 100644 --- a/templates/repository/common/CONTRIBUTING.md +++ b/templates/repository/common/CONTRIBUTING.md @@ -28,37 +28,45 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING ## Introduction -There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level -overview of how you can get involved. - -_Please note_: We take Ory $PROJECT's security and our users' trust very seriously. If you believe you have found a security issue -in Ory $PROJECT, please responsibly disclose by contacting us at security@ory.sh. - -First: As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and -holidays. Please do not ever hesitate to ask a question or send a pull request. - -If you are unsure, just ask or submit the issue or pull request anyways. You won't be yelled at for giving it your best effort. -The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't -want a wall of rules to get in the way of that. - -That said, if you want to ensure that a pull request is likely to be merged, talk to us! You can find out our thoughts and ensure -that your contribution won't clash or be obviated by Ory +There are many ways in which you can contribute, beyond writing code. The goal +of this document is to provide a high-level overview of how you can get +involved. + +_Please note_: We take Ory $PROJECT's security and our users' trust very +seriously. If you believe you have found a security issue in Ory $PROJECT, +please responsibly disclose by contacting us at security@ory.sh. + +First: As a potential contributor, your changes and ideas are welcome at any +hour of the day or night, weekdays, weekends, and holidays. Please do not ever +hesitate to ask a question or send a pull request. + +If you are unsure, just ask or submit the issue or pull request anyways. You +won't be yelled at for giving it your best effort. The worst that can happen is +that you'll be politely asked to change something. We appreciate any sort of +contributions, and don't want a wall of rules to get in the way of that. + +That said, if you want to ensure that a pull request is likely to be merged, +talk to us! You can find out our thoughts and ensure that your contribution +won't clash or be obviated by Ory $PROJECT's normal direction. A great way to do this is via -[Ory $PROJECT Discussions]($DISCUSSIONS) or the -[Ory Chat](https://www.ory.sh/chat). +[Ory $PROJECT Discussions]($DISCUSSIONS) +or the [Ory Chat](https://www.ory.sh/chat). ## FAQ - I am new to the community. Where can I find the [Ory Community Code of Conduct?](https://github.com/$REPOSITORY/blob/master/CODE_OF_CONDUCT.md) -- I have a question. Where can I get [answers to questions regarding Ory $PROJECT?](#communication) +- I have a question. Where can I get + [answers to questions regarding Ory $PROJECT?](#communication) -- I would like to contribute but I am not sure how. Are there [easy ways to contribute?](#how-can-i-contribute) +- I would like to contribute but I am not sure how. Are there + [easy ways to contribute?](#how-can-i-contribute) [Or good first issues?](https://github.com/search?l=&o=desc&q=label%3A%22help+wanted%22+label%3A%22good+first+issue%22+is%3Aopen+user%3Aory+user%3Aory-corp&s=updated&type=Issues) -- I want to talk to other Ory $PROJECT users. [How can I become a part of the community?](#communication) +- I want to talk to other Ory $PROJECT users. + [How can I become a part of the community?](#communication) - I would like to know what I am agreeing to when I contribute to Ory $PROJECT. @@ -73,63 +81,80 @@ do this is via If you want to start contributing code right away, we have a [list of good first issues](https://github.com/$REPOSITORY/labels/good%20first%20issue). -There are many other ways you can contribute without writing any code. Here are a few things you can do to help out: +There are many other ways you can contribute without writing any code. Here are +a few things you can do to help out: -- **Give us a star.** It may not seem like much, but it really makes a difference. This is something that everyone can do to help - out Ory $PROJECT. Github stars help the project gain visibility and stand out. +- **Give us a star.** It may not seem like much, but it really makes a + difference. This is something that everyone can do to help out Ory $PROJECT. + Github stars help the project gain visibility and stand out. -- **Join the community.** Sometimes helping people can be as easy as listening to their problems and offering a different - perspective. Join our Slack, have a look at discussions in the forum and take part in our weekly hangout. More info on this in - [Communication](#communication). +- **Join the community.** Sometimes helping people can be as easy as listening + to their problems and offering a different perspective. Join our Slack, have a + look at discussions in the forum and take part in our weekly hangout. More + info on this in [Communication](#communication). -- **Helping with open issues.** We have a lot of open issues for Ory $PROJECT and some of them may lack necessary information, - some are duplicates of older issues. You can help out by guiding people through the process of filling out the issue template, - asking for clarifying information, or pointing them to existing issues that match their description of the problem. +- **Helping with open issues.** We have a lot of open issues for Ory $PROJECT + and some of them may lack necessary information, some are duplicates of older + issues. You can help out by guiding people through the process of filling out + the issue template, asking for clarifying information, or pointing them to + existing issues that match their description of the problem. -- **Reviewing documentation changes.** Most documentation just needs a review for proper spelling and grammar. If you think a - document can be improved in any way, feel free to hit the `edit` button at the top of the page. More info on contributing to - documentation [here](#documentation). +- **Reviewing documentation changes.** Most documentation just needs a review + for proper spelling and grammar. If you think a document can be improved in + any way, feel free to hit the `edit` button at the top of the page. More info + on contributing to documentation [here](#documentation). -- **Help with tests.** Some pull requests may lack proper tests or test plans. These are needed for the change to be implemented - safely. +- **Help with tests.** Some pull requests may lack proper tests or test plans. + These are needed for the change to be implemented safely. ## Communication -We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to -other users of Ory, etc. +We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask +questions, discuss bugs and feature requests, talk to other users of Ory, etc. -Check out [Ory $PROJECT Discussions]($DISCUSSIONS). This is a great place for in-depth discussions and lots of code examples, logs -and similar data. +Check out [Ory $PROJECT Discussions]($DISCUSSIONS). This is a great place for +in-depth discussions and lots of code examples, logs and similar data. -You can also join our community hangout, if you want to speak to the Ory team directly or ask some questions. You can find more -info on the hangouts in [Slack](https://www.ory.sh/chat). +You can also join our community hangout, if you want to speak to the Ory team +directly or ask some questions. You can find more info on the hangouts in +[Slack](https://www.ory.sh/chat). -If you want to receive regular notifications about updates to Ory $PROJECT, consider joining the mailing list. We will _only_ send -you vital information on the projects that you are interested in. +If you want to receive regular notifications about updates to Ory $PROJECT, +consider joining the mailing list. We will _only_ send you vital information on +the projects that you are interested in. Also [follow us on twitter](https://twitter.com/orycorp). ## Contributing Code -Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or -[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with Ory $PROJECT's roadmap and -architecture. +Unless you are fixing a known bug, we **strongly** recommend discussing it with +the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat) +before getting started to ensure your work is consistent with Ory $PROJECT's +roadmap and architecture. -All contributions are made via pull requests. To make a pull request, you will need a GitHub account; if you are unclear on this -process, see GitHub's documentation on [forking](https://help.github.com/articles/fork-a-repo) and -[pull requests](https://help.github.com/articles/using-pull-requests). Pull requests should be targeted at the `master` branch. -Before creating a pull request, go through this checklist: +All contributions are made via pull requests. To make a pull request, you will +need a GitHub account; if you are unclear on this process, see GitHub's +documentation on [forking](https://help.github.com/articles/fork-a-repo) and +[pull requests](https://help.github.com/articles/using-pull-requests). Pull +requests should be targeted at the `master` branch. Before creating a pull +request, go through this checklist: 1. Create a feature branch off of `master` so that changes do not get mixed up. -1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch. -1. Run the full project test suite with the `go test -tags sqlite ./...` (or equivalent) command and confirm that it passes. -1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is written in Go, `npm run format` if the project is - written for NodeJS. -1. Ensure that each commit has a descriptive prefix. This ensures a uniform commit history and helps structure the changelog. - Please refer to this [list of prefixes for $PROJECT](https://github.com/$REPOSITORY/blob/master/.github/semantic.yml) for an - overview. -1. Sign-up with CircleCI so that it has access to your repository with the branch containing your PR. Simply creating a CircleCI - account is sufficient for the CI jobs to run, you do not need to setup a CircleCI project for the branch. +1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local + changes against the `master` branch. +1. Run the full project test suite with the `go test -tags sqlite ./...` (or + equivalent) command and confirm that it passes. +1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is + written in Go, `npm run format` if the project is written for NodeJS. +1. Ensure that each commit has a descriptive prefix. This ensures a uniform + commit history and helps structure the changelog. + Please refer to this + [list of prefixes for $PROJECT](https://github.com/$REPOSITORY/blob/master/.github/semantic.yml) + for an overview. +1. Sign-up with CircleCI so that it has access to your repository with the + branch containing your PR. Simply creating a CircleCI account is sufficient + for the CI jobs to run, you do not need to setup a CircleCI project for the + branch. If a pull request is not ready to be reviewed yet [it should be marked as a "Draft"](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request). @@ -137,46 +162,55 @@ If a pull request is not ready to be reviewed yet Before your contributions can be reviewed you need to sign our [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY). -This agreement defines the terms under which your code is contributed to Ory. More specifically it declares that you have the -right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our -projects are published [here](https://github.com/ory/meta/blob/master/LICENSE). +This agreement defines the terms under which your code is contributed to Ory. +More specifically it declares that you have the right to, and actually do, grant +us the rights to use your contribution. You can see the Apache 2.0 license under +which our projects are published +[here](https://github.com/ory/meta/blob/master/LICENSE). -When pull requests fail testing, authors are expected to update their pull requests to address the failures until the tests pass. +When pull requests fail testing, authors are expected to update their pull +requests to address the failures until the tests pass. Pull requests eligible for review 1. follow the repository's code formatting conventions; -2. include tests which prove that the change works as intended and does not add regressions; +2. include tests which prove that the change works as intended and does not add + regressions; 3. document the changes in the code and/or the project's documentation; 4. pass the CI pipeline; -5. have signed our [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY); +5. have signed our + [Contributor License Agreement](https://cla-assistant.io/$REPOSITORY); 6. include a proper git commit message following the [Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/). -If all of these items are checked, the pull request is ready to be reviewed and you should change the status to "Ready for review" -and +If all of these items are checked, the pull request is ready to be reviewed and +you should change the status to "Ready for review" and [request review from a maintainer](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). Reviewers will approve the pull request once they are satisfied with the patch. ## Documentation -Please provide documentation when changing, removing, or adding features. Documentation resides in the project's -[docs](https://github.com/$REPOSITORY/tree/master/docs) folder. Generate API and configuration reference documentation using -`cd docs; npm run gen`. +Please provide documentation when changing, removing, or adding features. +Documentation resides in the project's +[docs](https://github.com/$REPOSITORY/tree/master/docs) folder. Generate API and +configuration reference documentation using `cd docs; npm run gen`. -For further instructions please head over to [docs/README.md](https://github.com/$REPOSITORY/blob/master/README.md). +For further instructions please head over to +[docs/README.md](https://github.com/$REPOSITORY/blob/master/README.md). ## Disclosing vulnerabilities -Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. +Please disclose vulnerabilities exclusively to +[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. ## Code Style Please follow these guidelines when formatting source code: - Go code should match the output of `gofmt -s` and pass `golangci-lint run`. -- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate. +- NodeJS and JavaScript code should be prettified using `npm run format` where + appropriate. ### Working with Forks @@ -207,19 +241,25 @@ Now go to the project's GitHub Pull Request page and click "New pull request" ## Conduct -Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your -back. +Whether you are a regular contributor or a newcomer, we care about making this +community a safe place for you and we've got your back. -- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, - disability, ethnicity, religion, or similar personal characteristic. -- Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all. +- We are committed to providing a friendly, safe and welcoming environment for + all, regardless of gender, sexual orientation, disability, ethnicity, + religion, or similar personal characteristic. +- Please avoid using nicknames that might detract from a friendly, safe and + welcoming environment for all. - Be kind and courteous. There is no need to be mean or rude. -- We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate behavior that - excludes people in socially marginalized groups. -- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made - uncomfortable by a community member, please contact one of the channel ops or a member of the Ory $PROJECT core team - immediately. -- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome. - -We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, -feedback, or concerns [please let us know](https://www.ory.sh/chat). +- We will exclude you from interaction if you insult, demean or harass anyone. + In particular, we do not tolerate behavior that excludes people in socially + marginalized groups. +- Private harassment is also unacceptable. No matter who you are, if you feel + you have been or are being harassed or made uncomfortable by a community + member, please contact one of the channel ops or a member of the Ory $PROJECT + core team immediately. +- Likewise any spamming, trolling, flaming, baiting or other attention-stealing + behaviour is not welcome. + +We welcome discussion about creating a welcoming, safe, and productive +environment for the community. If you have any questions, feedback, or concerns +[please let us know](https://www.ory.sh/chat). diff --git a/templates/repository/common/PROJECTS.md b/templates/repository/common/PROJECTS.md index 3127443..4c9c9b1 100644 --- a/templates/repository/common/PROJECTS.md +++ b/templates/repository/common/PROJECTS.md @@ -1,40 +1,49 @@ -We build Ory on several guiding principles when it comes to our architecture design: +We build Ory on several guiding principles when it comes to our architecture +design: - Minimal dependencies - Runs everywhere - Scales without effort - Minimize room for human and network errors -Ory's architecture is designed to run best on a Container Orchestration system such as Kubernetes, CloudFoundry, OpenShift, and -similar projects. Binaries are small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) and operating -systems (FreeBSD, Linux, macOS, Windows) without system dependencies (Java, Node, Ruby, libxml, ...). +Ory's architecture is designed to run best on a Container Orchestration system +such as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries are +small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) +and operating systems (FreeBSD, Linux, macOS, Windows) without system +dependencies (Java, Node, Ruby, libxml, ...). ### Ory Kratos: Identity and User Infrastructure and Management -[Ory Kratos](https://github.com/ory/kratos) is an API-first Identity and User Management system that is built according to -[cloud architecture best practices](https://www.ory.sh/docs/next/ecosystem/software-architecture-philosophy). It implements core -use cases that almost every software application needs to deal with: Self-service Login and Registration, Multi-Factor -Authentication (MFA/2FA), Account Recovery and Verification, Profile, and Account Management. +[Ory Kratos](https://github.com/ory/kratos) is an API-first Identity and User +Management system that is built according to +[cloud architecture best practices](https://www.ory.sh/docs/next/ecosystem/software-architecture-philosophy). +It implements core use cases that almost every software application needs to +deal with: Self-service Login and Registration, Multi-Factor Authentication +(MFA/2FA), Account Recovery and Verification, Profile, and Account Management. ### Ory Hydra: OAuth2 & OpenID Connect Server -[Ory Hydra](https://github.com/ory/hydra) is an OpenID Certified™ OAuth2 and OpenID Connect Provider which easily connects to any -existing identity system by writing a tiny "bridge" application. Gives absolute control over user interface and user experience -flows. +[Ory Hydra](https://github.com/ory/hydra) is an OpenID Certified™ OAuth2 and +OpenID Connect Provider which easily connects to any existing identity system by +writing a tiny "bridge" application. Gives absolute control over user interface +and user experience flows. ### Ory Oathkeeper: Identity & Access Proxy -[Ory Oathkeeper](https://github.com/ory/oathkeeper) is a BeyondCorp/Zero Trust Identity & Access Proxy (IAP) with configurable -authentication, authorization, and request mutation rules for your web services: Authenticate JWT, Access Tokens, API Keys, mTLS; -Check if the contained subject is allowed to perform the request; Encode resulting content into custom headers (`X-User-ID`), JSON -Web Tokens and more! +[Ory Oathkeeper](https://github.com/ory/oathkeeper) is a BeyondCorp/Zero Trust +Identity & Access Proxy (IAP) with configurable authentication, authorization, +and request mutation rules for your web services: Authenticate JWT, Access +Tokens, API Keys, mTLS; Check if the contained subject is allowed to perform the +request; Encode resulting content into custom headers (`X-User-ID`), JSON Web +Tokens and more! ### Ory Keto: Access Control Policies as a Server -[Ory Keto](https://github.com/ory/keto) is a policy decision point. It uses a set of access control policies, similar to AWS IAM -Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized to perform a certain action -on a resource. +[Ory Keto](https://github.com/ory/keto) is a policy decision point. It uses a +set of access control policies, similar to AWS IAM Policies, in order to +determine whether a subject (user, application, service, car, ...) is authorized +to perform a certain action on a resource. diff --git a/templates/repository/common/SECURITY.md b/templates/repository/common/SECURITY.md index 8152c97..70f1ef4 100644 --- a/templates/repository/common/SECURITY.md +++ b/templates/repository/common/SECURITY.md @@ -21,8 +21,8 @@ https://github.com/ory/meta/blob/master/templates/repository/SECURITY.md ## Supported Versions -We release patches for security vulnerabilities. Which versions are eligible receiving such patches depend on the CVSS v3.0 -Rating: +We release patches for security vulnerabilities. Which versions are eligible +receiving such patches depend on the CVSS v3.0 Rating: | CVSS v3.0 | Supported Versions | | --------- | ----------------------------------------- | @@ -31,6 +31,7 @@ Rating: ## Reporting a Vulnerability -Please report (suspected) security vulnerabilities to **[security@ory.sh](mailto:security@ory.sh)**. You will receive a response -from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but -historically within a few days. +Please report (suspected) security vulnerabilities to +**[security@ory.sh](mailto:security@ory.sh)**. You will receive a response from +us within 48 hours. If the issue is confirmed, we will release a patch as soon +as possible depending on complexity but historically within a few days. diff --git a/templates/repository/library/.github/pull_request_template.md b/templates/repository/library/.github/pull_request_template.md index 29d4613..1f51f75 100644 --- a/templates/repository/library/.github/pull_request_template.md +++ b/templates/repository/library/.github/pull_request_template.md @@ -37,9 +37,9 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh - [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md) and signed the CLA. - [ ] I have referenced an issue containing the design document if my change introduces a new feature. - [ ] I have read the [security policy](../security/policy). -- [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security - vulnerability, I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the - maintainers to push the changes. +- [ ] I confirm that this pull request does not address a security vulnerability. + If this pull request addresses a security vulnerability, + I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the maintainers to push the changes. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added necessary documentation within the code base (if appropriate). diff --git a/templates/repository/server/.github/pull_request_template.md b/templates/repository/server/.github/pull_request_template.md index d8bcb16..d22b92a 100644 --- a/templates/repository/server/.github/pull_request_template.md +++ b/templates/repository/server/.github/pull_request_template.md @@ -41,9 +41,9 @@ If you're unsure about any of them, don't hesitate to ask. We're here to help! - [ ] I have referenced an issue containing the design document if my change introduces a new feature. - [ ] I am following the [contributing code guidelines](../blob/master/CONTRIBUTING.md#contributing-code). - [ ] I have read the [security policy](../security/policy). -- [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security. - vulnerability, I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the - maintainers to push the changes. +- [ ] I confirm that this pull request does not address a security vulnerability. + If this pull request addresses a security. vulnerability, + I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the maintainers to push the changes. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added or changed [the documentation](https://github.com/ory/docs). diff --git a/templates/repository/server/.github/workflows/milestone.yml b/templates/repository/server/.github/workflows/milestone.yml index b4a3069..fb47e4a 100644 --- a/templates/repository/server/.github/workflows/milestone.yml +++ b/templates/repository/server/.github/workflows/milestone.yml @@ -3,7 +3,7 @@ name: Generate and Publish Milestone Document on: workflow_dispatch: schedule: - - cron: '0 0 * * *' + - cron: "0 0 * * *" jobs: milestone: @@ -23,8 +23,8 @@ jobs: - name: Commit Milestone Documentation uses: EndBug/add-and-commit@v4.4.0 with: - message: 'autogen(docs): update milestone document' + message: "autogen(docs): update milestone document" author_name: aeneasr - author_email: '3372410+aeneasr@users.noreply.github.com' + author_email: "3372410+aeneasr@users.noreply.github.com" env: GITHUB_TOKEN: ${{ secrets.TOKEN_PRIVILEGED }}