An open API service indexing awesome lists of open source software.

https://github.com/ory/meta

A place where we plan and schedule our open source activities and track cross-project and ory-wide issues
https://github.com/ory/meta

hacktoberfest

Last synced: 12 months ago
JSON representation

A place where we plan and schedule our open source activities and track cross-project and ory-wide issues

Awesome Lists containing this project

README

          

# meta

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.

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.

## Github Sync action

The [meta scripts](https://github.com/ory/meta/tree/master/scripts) 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).

To run the sync script locally, open a Bash terminal and copy the respective
commands from [sync.sh](https://github.com/ory/meta/blob/master/scripts/sync.sh)
into the terminal. For example, to see the changes made by all sync jobs:

```
source scripts/sync.sh
workspace=$(create_workspace)
GITHUB_SHA=12345
replicate_all "$workspace" keep
```

Then `cd $workspace` to see all repositories with the uncommitted changes made
by the sync script. To test committing, replace the last line with this one:

```
replicate_all "$workspace" commit
```

To test syncing problems with a single repo:

```
source scripts/sync.sh
workspace=$(create_workspace)
GITHUB_SHA=12345
replicate ory/hydra server "Hydra" "$workspace" "keep"
```