-
Notifications
You must be signed in to change notification settings - Fork 22
Add markdown formatting on commit #241
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,49 @@ | ||||||||||||||
| # Copilot Instructions — Equinor AppSec | ||||||||||||||
|
|
||||||||||||||
| ## Project Overview | ||||||||||||||
|
|
||||||||||||||
| MkDocs documentation site for Equinor Application Security guidelines. Pure documentation — no application code. | ||||||||||||||
|
|
||||||||||||||
| - **Stack:** MkDocs Material theme, Python 3.12+, uv package manager | ||||||||||||||
| - **Site URL:** <https://equinor.github.io/appsec/> | ||||||||||||||
| - **Repo:** <https://github.com/equinor/appsec/> | ||||||||||||||
|
|
||||||||||||||
| ## Commands | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| uv sync # Install dependencies | ||||||||||||||
| uv run mkdocs serve # Local dev server on http://localhost:8000 | ||||||||||||||
| uv run mkdocs build # Build static site to site/ | ||||||||||||||
| pip install -e ".[dev]" # Install dev tools (pre-commit, mdformat) | ||||||||||||||
| pre-commit install # Set up git hooks | ||||||||||||||
| pre-commit run --all-files # Run formatting on all files | ||||||||||||||
|
Comment on lines
+17
to
+19
|
||||||||||||||
| pip install -e ".[dev]" # Install dev tools (pre-commit, mdformat) | |
| pre-commit install # Set up git hooks | |
| pre-commit run --all-files # Run formatting on all files | |
| uv sync --extra dev # Install dev tools (pre-commit, mdformat) | |
| uv run pre-commit install # Set up git hooks | |
| uv run pre-commit run --all-files # Run formatting on all files |
Copilot
AI
Mar 23, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The relative links to workflow files are incorrect from within .github/ (they currently point to .github/.github/workflows/...). Use paths relative to this file (e.g. workflows/gh-pages.yml) so the links work on GitHub.
| 1. **GitHub Pages** — `uv run mkdocs gh-deploy --force` ([gh-pages.yml](.github/workflows/gh-pages.yml)) | |
| 2. **Azure Static Web Apps** — builds `site/`, deploys via Azure token ([azure-static-webapp.yml](.github/workflows/azure-static-webapp.yml)) | |
| 3. **Backstage TechDocs** — generates and publishes to Azure Blob Storage ([backstage-techdocs.yml](.github/workflows/backstage-techdocs.yml)) | |
| 1. **GitHub Pages** — `uv run mkdocs gh-deploy --force` ([gh-pages.yml](workflows/gh-pages.yml)) | |
| 2. **Azure Static Web Apps** — builds `site/`, deploys via Azure token ([azure-static-webapp.yml](workflows/azure-static-webapp.yml)) | |
| 3. **Backstage TechDocs** — generates and publishes to Azure Blob Storage ([backstage-techdocs.yml](workflows/backstage-techdocs.yml)) |
Copilot
AI
Mar 23, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CONTRIBUTING.md is referenced with a relative link, but from .github/copilot-instructions.md it should go up one level (otherwise it points to .github/CONTRIBUTING.md).
| See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines. Test links, run markdown linter, use a spell checker. Follow conventional commit messages for clarity. | |
| See [CONTRIBUTING.md](../CONTRIBUTING.md) for full guidelines. Test links, run markdown linter, use a spell checker. Follow conventional commit messages for clarity. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,4 +6,5 @@ venv/ | |
| .venv/ | ||
| .dccache | ||
| .DS_STORE | ||
| .idea/ | ||
| .idea/ | ||
| *.egg-info/ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # mdformat configuration | ||
| # Use 4-space indentation for nested lists (required by MkDocs / Python-Markdown) | ||
| [plugin.mkdocs] |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,8 @@ | ||||||
| repos: | ||||||
| - repo: https://github.com/executablebooks/mdformat | ||||||
| rev: 0.7.21 | ||||||
| hooks: | ||||||
| - id: mdformat | ||||||
| additional_dependencies: | ||||||
| - mdformat-mkdocs | ||||||
|
||||||
| - mdformat-mkdocs | |
| - mdformat-mkdocs==0.2.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
post-create.shinstalls uv but then uses plainpip install -e ".[dev]", which bypassesuv.lockand can yield different tool versions thanuv runuses. Preferuv sync --extra dev(and runpre-commitviauv run) so Codespaces uses the locked, reproducible environment.