From d35171c72f2c82066fde7241f97bb36b442351ac Mon Sep 17 00:00:00 2001 From: Merlijn Sebrechts Date: Tue, 5 Dec 2023 14:49:24 +0100 Subject: [PATCH] unwrap md --- README.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 738e83b..fe23dd0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ # Snapcrafters CI -This repository contains common actions and tools used throughout the Snapcrafters -[organisation](https://github.com/snapcrafters) for the testing and delivery of our snaps. +This repository contains common actions and tools used throughout the Snapcrafters [organisation](https://github.com/snapcrafters) for the testing and delivery of our snaps. ## Snapcrafters Actions -The actions in this repo are all used during the build, test and release of our snaps. Each of them -listed below has it's own README +The actions in this repo are all used during the build, test and release of our snaps. Each of them listed below has it's own README - [snapcrafters/ci/call-for-testing](call-for-testing/README.md) - [snapcrafters/ci/get-architectures](get-architectures/README.md) @@ -30,18 +28,10 @@ If you'd like to contribute to this repository, please feel free to fork and cre There are a few style guidelines to keep in mind: -- Code should be linted using [Prettier](https://prettier.io/). You can achieve this with `make -lint` and `make format`. The only requirements are [`npx`](https://www.npmjs.com/package/npx) and - [`shellcheck`](https://github.com/koalaman/shellcheck). -- When defining inputs/outputs in `action.yaml`, or listing them in the tables within `README.md`, - they should be listed in alphabetical order for easy reading and updating. -- Github Action inputs/outputs should be named all lowercase, separated by `-` where needed. The - applies to inputs/outputs to actions themselves, and for individual steps within the actions. For - example: `snap-name` or `token`. -- Environment variables referring to repository level secrets and variables should be named all - uppercase, and separated by `_`. For example: `SNAPCRAFTERS_BOT_COMMIT`. -- Step/job level environment variables should be named all lowercase, and separated by `_`. For - example: `snap_name` or `yaml_path`. +- Code should be linted using [Prettier](https://prettier.io/). You can achieve this with `make lint` and `make format`. The only requirements are [`npx`](https://www.npmjs.com/package/npx) and [`shellcheck`](https://github.com/koalaman/shellcheck). +- When defining inputs/outputs in `action.yaml`, or listing them in the tables within `README.md`, they should be listed in alphabetical order for easy reading and updating. +- Github Action inputs/outputs should be named all lowercase, separated by `-` where needed. The applies to inputs/outputs to actions themselves, and for individual steps within the actions. For example: `snap-name` or `token`. +- Environment variables referring to repository level secrets and variables should be named all uppercase, and separated by `_`. For example: `SNAPCRAFTERS_BOT_COMMIT`. +- Step/job level environment variables should be named all lowercase, and separated by `_`. For example: `snap_name` or `yaml_path`. - All `bash` variables should be quoted. -- Scripts of all kinds, including those within actions `run:|` directives should follow the [Google - styleguide](https://google.github.io/styleguide/shellguide.html) +- Scripts of all kinds, including those within actions `run:|` directives should follow the [Google styleguide](https://google.github.io/styleguide/shellguide.html)