Skip to content

Commit

Permalink
ci: bump super-linter (#961)
Browse files Browse the repository at this point in the history
  • Loading branch information
dunglas authored Oct 23, 2024
1 parent 6c511ee commit 04030c1
Show file tree
Hide file tree
Showing 45 changed files with 1,262 additions and 1,060 deletions.
3 changes: 1 addition & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
version: 2
updates:
-
package-ecosystem: github-actions
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
Expand Down
14 changes: 7 additions & 7 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@
###############
# Rules by id #
###############
MD004: false # Unordered list style
MD004: false # Unordered list style
MD007:
indent: 2 # Unordered list indentation
indent: 2 # Unordered list indentation
MD010:
ignore_code_languages: [caddyfile]
MD013: false
MD026:
punctuation: ".,;:!。,;:" # List of not allowed
MD029: false # Ordered list item prefix
MD033: false # Allow inline HTML
MD036: false # Emphasis used instead of a heading
punctuation: ".,;:!。,;:" # List of not allowed
MD029: false # Ordered list item prefix
MD033: false # Allow inline HTML
MD036: false # Emphasis used instead of a heading

#################
# Rules by tags #
#################
blank_lines: false # Error on blank lines
blank_lines: false # Error on blank lines
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Examples:
docs: Add docs for X
spec: Z disambiguation
-->
-->
2 changes: 1 addition & 1 deletion .github/workflows/cd-chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Release Chart
on:
push:
tags:
- 'v*'
- "v*"

jobs:
release:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: '1.23'
go-version: "1.23"
cache-dependency-path: |
go.sum
caddy/go.sum
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
if: startsWith(github.ref, 'refs/tags/v')
uses: actions/attest-build-provenance@v1
with:
subject-path: '${{ github.workspace }}/dist/**/mercure'
subject-path: "${{ github.workspace }}/dist/**/mercure"

- name: Display version
run: dist/caddy_linux_amd64_v1/mercure version
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:

- uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: "3.10"

- name: Set up chart-testing
uses: helm/chart-testing-action@v2
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:
- v*.*.*

env:
GO111MODULE: 'on'
GO111MODULE: "on"

jobs:
golangci:
Expand All @@ -23,7 +23,7 @@ jobs:

- uses: actions/setup-go@v5
with:
go-version: '1.23'
go-version: "1.23"
cache-dependency-path: |
go.sum
caddy/go.sum
Expand All @@ -37,7 +37,7 @@ jobs:
test:
strategy:
matrix:
go: [ '1.21', '1.22', '1.23' ]
go: ["1.21", "1.22", "1.23"]
fail-fast: false
name: Test
runs-on: ubuntu-latest
Expand Down Expand Up @@ -82,8 +82,8 @@ jobs:

- uses: actions/setup-node@v4
with:
node-version: '16'
cache: 'npm'
node-version: "16"
cache: "npm"
cache-dependency-path: conformance-tests/package-lock.json

- name: Install Playwrigth dependencies
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ jobs:
VALIDATE_GO_RELEASER: false
VALIDATE_PHP_PHPCS: false
VALIDATE_KUBERNETES_KUBECONFORM: false
VALIDATE_JAVASCRIPT_PRETTIER: false
VALIDATE_TYPESCRIPT_PRETTIER: false
VALIDATE_JAVASCRIPT_STANDARD: false
VALIDATE_TYPESCRIPT_STANDARD: false
VALIDATE_PYTHON_PYLINT: false
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# The spec is in the IETF flavor of Markdown
spec/mercure.md

# Ignore Kubernetes templates
**/charts/**/*.yaml
**/chart/**/*.yaml
charts/mercure/README.md

*cache
38 changes: 19 additions & 19 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch the hub",
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/caddy/mercure",
"env": {
"MERCURE_PUBLISHER_JWT_KEY": "!ChangeThisMercureHubJWTSecretKey!",
"MERCURE_SUBSCRIBER_JWT_KEY": "!ChangeThisMercureHubJWTSecretKey!",
"MERCURE_EXTRA_DIRECTIVES": "anonymous\nwrite_timeout 10s",
"GLOBAL_OPTIONS": "debug",
"SERVER_NAME": "localhost, host.docker.internal",
"CADDY_SERVER_EXTRA_DIRECTIVES": "tls internal"
},
"args": ["run", "--config", "../../dev.Caddyfile"]
}
]
"version": "0.2.0",
"configurations": [
{
"name": "Launch the hub",
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/caddy/mercure",
"env": {
"MERCURE_PUBLISHER_JWT_KEY": "!ChangeThisMercureHubJWTSecretKey!",
"MERCURE_SUBSCRIBER_JWT_KEY": "!ChangeThisMercureHubJWTSecretKey!",
"MERCURE_EXTRA_DIRECTIVES": "anonymous\nwrite_timeout 10s",
"GLOBAL_OPTIONS": "debug",
"SERVER_NAME": "localhost, host.docker.internal",
"CADDY_SERVER_EXTRA_DIRECTIVES": "tls internal"
},
"args": ["run", "--config", "../../dev.Caddyfile"]
}
]
}
36 changes: 18 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ If you include code from another project, please mention it in the Pull Request
The commit message must follow the [Conventional Commits specification](https://www.conventionalcommits.org/).
The following types are allowed:

* `fix`: bugfix
* `feat`: new feature
* `docs`: change in the documentation
* `spec`: spec change
* `test`: test-related change
* `perf`: performance optimization
* `ci`: CI-related change
- `fix`: bugfix
- `feat`: new feature
- `docs`: change in the documentation
- `spec`: spec change
- `test`: test-related change
- `perf`: performance optimization
- `ci`: CI-related change

Examples:

Expand Down Expand Up @@ -61,10 +61,10 @@ Go to `http://localhost:3000` and enjoy!

When you send a PR, make sure that:

* You add valid test cases.
* Tests are green.
* You make a PR on the related documentation.
* You make the PR on the same branch you based your changes on. If you see commits
- You add valid test cases.
- Tests are green.
- You make a PR on the related documentation.
- You make the PR on the same branch you based your changes on. If you see commits
that you did not make in your PR, you're doing it wrong.

### Configuring Visual Studio Code
Expand All @@ -88,10 +88,10 @@ It is then converted in the [the "xml2rfc" Version 3 Vocabulary](https://tools.i

To contribute to the protocol itself:

* Make your changes
* [Download Mmark](https://github.com/mmarkdown/mmark/releases)
* [Download `xml2rfc` using pip](https://pypi.org/project/xml2rfc/): `pip install xml2rfc`
* Generate the XML file: `mmark spec/mercure.md > spec/mercure.xml`
* Validate the generated XML file and generate the text file: `xml2rfc --text --v3 spec/mercure.xml`
* Remove non-ASCII characters from the generated `mercure.txt` file (example: K**é**vin)
* If appropriate, be sure to update the reference implementation accordingly
- Make your changes
- [Download Mmark](https://github.com/mmarkdown/mmark/releases)
- [Download `xml2rfc` using pip](https://pypi.org/project/xml2rfc/): `pip install xml2rfc`
- Generate the XML file: `mmark spec/mercure.md > spec/mercure.xml`
- Validate the generated XML file and generate the text file: `xml2rfc --text --v3 spec/mercure.xml`
- Remove non-ASCII characters from the generated `mercure.txt` file (example: K**é**vin)
- If appropriate, be sure to update the reference implementation accordingly
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center"><a href="https://mercure.rocks"><img src="public/mercure.svg" alt="Mercure: Real-time Made Easy" title="Live Updates Made Easy"></a></h1>

*Protocol and Reference Implementation*
_Protocol and Reference Implementation_

Mercure is a protocol for pushing data updates to web browsers and other HTTP clients in a convenient, fast, reliable, and battery-efficient way.
It is especially useful to publish async and real-time updates of resources served through web APIs, to reactive web and mobile apps.
Expand All @@ -14,9 +14,9 @@ It is especially useful to publish async and real-time updates of resources serv

![Subscriptions Schema](spec/subscriptions.png)

* [Getting started](https://mercure.rocks/docs/getting-started)
* [Full documentation](https://mercure.rocks/docs)
* [Demo](https://demo.mercure.rocks/)
- [Getting started](https://mercure.rocks/docs/getting-started)
- [Full documentation](https://mercure.rocks/docs)
- [Demo](https://demo.mercure.rocks/)

[The protocol](https://mercure.rocks/spec) is maintained in this repository and is also available as [an Internet-Draft](https://datatracker.ietf.org/doc/draft-dunglas-mercure/).

Expand Down
18 changes: 15 additions & 3 deletions cmd/mercure/mercure.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@ debug: true
allow_anonymous: true
#cert_file: fixtures/tls/server.crt
#key_file: fixtures/tls/server.key
cors_allowed_origins: [http://localhost:3000, http://localhost:3001, http://localhost:5000, http://localhost:8000]
cors_allowed_origins:
[
http://localhost:3000,
http://localhost:3001,
http://localhost:5000,
http://localhost:8000,
]
transport_url: bolt://update.db
jwt_key: '!ChangeThisMercureHubJWTSecretKey!'
publish_allowed_origins: [http://localhost:3000, http://localhost:3001, http://localhost:5000, http://localhost:8000]
jwt_key: "!ChangeThisMercureHubJWTSecretKey!"
publish_allowed_origins:
[
http://localhost:3000,
http://localhost:3001,
http://localhost:5000,
http://localhost:8000,
]
subscriptions: true

metrics_enabled: false
Expand Down
Loading

0 comments on commit 04030c1

Please sign in to comment.