Skip to content

Commit

Permalink
docs: unwrap lines in README (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
merlijn-sebrechts authored Dec 5, 2023
1 parent 94092c9 commit 476d261
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)

0 comments on commit 476d261

Please sign in to comment.