Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/xenitab/azure-devops-templates

Collection of templates to use in Azure DevOps
https://github.com/xenitab/azure-devops-templates

xenit-kubernetes-framework

Last synced: 29 days ago
JSON representation

Collection of templates to use in Azure DevOps

Awesome Lists containing this project

README 

        
# Azure DevOps Templates



Collection of templates to use in Azure DevOps and GitHub



## Usage



Currently neither Azure DevOps nor GitHub support referencing templates from public GitHub repositories without

specifying a valid service connection. This would be too cumbersome to deal with for multiple organizations.

Instead this repo is best used by creating a mirror of it, and using a pipeline to synchronize the content from upstream.



### Importing the repository to Azure DevOps



Begin by [importing the repository](https://docs.microsoft.com/en-us/azure/devops/repos/git/import-git-repository?view=azure-devops) into a global project in your organization.



- Azure DevOps > Project > Repos > Import Repository

  - Repository type: Git

  - Clone URL: https://github.com/XenitAB/azure-devops-templates.git

  - [ ] Requires Authentication

  - Name: azure-devops-templates

- Press "Import"



#### Configuring Build Service permissions



Configure Build Service to have permission to push changes to the template repository.



- Azure DevOps > Project > Project settings > Repositories > azure-devops-templates > Permissions

- [Project Name] Build Service ([org name]):

  - Contribute: `Allow`

  - Create branch: `Allow`

  - Force push (rewrite history, delete branches and tags): `Allow`



#### Adding Azure Pipelines for repository syncronization



Then create a pipeline from the definition located in `./ci/pipeline.yaml`, this pipeline will sync with Github.

Any time you want to get the latest changes you need to run this pipeline.



- Azure DevOps > Project > Repos > Set up build

- Choose Azisting Azure Pipelines YAML file

  - Branch: master

  - Path: /.ci/pipeline.yaml

- Press Continue > Press Run



#### Adding reference to the synchronized repository



You should be able to use the templates when the mirroring is complete by referencing the git repository.



```yaml

resources:

  repositories:

    - repository: templates

      type: git

      name: /azure-devops-templates

      ref: refs/tags/



stages:

  - template: gitops/deploy/pipeline.yaml@templates

```



### Importing the repository to GitHub



Begin by [importing the repository](https://github.com/new/import) into a global project in your organization.



- GitHub > Repositories > New > Import a repository

  - Clone URL: https://github.com/XenitAB/azure-devops-templates.git

  - Owner:  / azure-devops-templates

  - Privacy: Public

- Press "Begin Import"



#### Keeping the repository up to date



The repository contains a GitHub Action that will automatically run and update the `main` branch from upstream at least once per hour, see [`./.github/workflows/update-azure-devops-templates-from-upstream.yaml`](https://github.com/XenitAB/azure-devops-templates/blob/main/.github/workflows/update-azure-devops-templates-from-upstream.yaml). It is not required to use this (you can keep the `main` branch up to date manually if you prefer), but it is recommended.



In order for this to run correctly, you need to register a new (or reuse an existing) GitHub App **private to your organization** with the appropriate access. To do this, [go here](https://github.com/settings/apps/new). It is important that the app has read and write access to `contents` and `workflows`.



Please note that after registering an application, you also need to install it into your organization for it to have the correct access. It is not enough to just register the application.



As you register your app, you will receive an _application id_ and a _private key_. These need to be added to the secrets for your repository:



- Add the _application id_ as a secret named `UPDATE_FROM_UPSTREAM_APP_ID` (this will look something like `152762`)

- Add the _private key_ as a secret named `UPDATE_FROM_UPSTREAM_PRIVATE_KEY` (this is the contents of the `.pem` file , which starts with `-----BEGIN RSA PRIVATE KEY-----` and runs over several lines)



# Versioning



Versions follow the [CalVer](https://calver.org/) standard. This simplifies detecting usage of very old versions.

The versions should use the following pattern `YYYY.0M.MICRO`. The micro value starts at 0 and increments by one

for each release during the same month.



# License



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.