Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 17 additions & 32 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: Build and Deploy Documentation

# mike commits each version of the site to the gh-pages branch, which GitHub Pages serves.
on:
push:
branches:
- main
# paths:
# - "docs/**"
# - "mkdocs.yml"
release:
types: [published]

permissions:
contents: write
pages: write
id-token: write

concurrency:
group: docs
cancel-in-progress: false

jobs:
build:
Expand All @@ -39,36 +39,21 @@ jobs:
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'

- name: Build Docs Website
# Rules added since the last release show "Unreleased" until their version is stamped in the
# source; the released docs show the version they ship in.
- name: Stamp unreleased rules
if: github.event_name == 'release'
env:
VERSION: ${{ github.event.release.tag_name }}
run: sed -i "s/\*\*Since\*\* \`Unreleased\`/**Since** \`$VERSION\`/" docs/reference/rules/*.md

- name: Build and push the docs
env:
VERSION: ${{ github.event.release.tag_name }}
run: |
if [ "${{ github.event_name }}" = "release" ]; then
uv run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
uv run mike deploy --push --update-aliases "$VERSION" latest
uv run mike set-default --push latest
else
uv run mike deploy --push main
fi

deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

36 changes: 36 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -276,3 +276,39 @@ jobs:
echo "[Link](${{ steps.create-release.outputs.url }})"
echo ""
} >> "$GITHUB_STEP_SUMMARY"

# New rules are written with `version: "next"`. Once the version of a release is known, open a
# PR that sets it.
stamp_rule_versions:
name: Stamp Rule Versions
runs-on: ubuntu-latest
needs: [extract_version, create_changelog_and_release]
permissions:
contents: write
pull-requests: write
steps:
- uses: actions/checkout@v4
with:
ref: main

- name: Open a PR that stamps the version
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
VERSION: ${{ needs.extract_version.outputs.version }}
run: |
files=$(grep -rl 'version: "next"' crates/pgls_analyser/src/lint || true)
if [ -z "$files" ]; then
echo "No unreleased rules."
exit 0
fi
branch="chore/stamp-rule-versions-$VERSION"
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
git checkout -b "$branch"
echo "$files" | xargs sed -i "s/version: \"next\"/version: \"$VERSION\"/"
sed -i "s/\*\*Since\*\* \`Unreleased\`/**Since** \`$VERSION\`/" docs/reference/rules/*.md
git commit -am "chore: stamp the version of rules released in $VERSION"
git push origin "$branch"
gh pr create --base main --head "$branch" \
--title "chore: stamp the version of rules released in $VERSION" \
--body "Sets the version of the rules first released in $VERSION."
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.13
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidAlterEnumAddValue {
version: "next",
version: "0.25.0",
name: "avoidAlterEnumAddValue",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ declare_lint_rule! {
/// ```
///
pub BanConcurrentIndexCreationInTransaction {
version: "next",
version: "0.15.0",
name: "banConcurrentIndexCreationInTransaction",
severity: Severity::Error,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare_lint_rule! {
/// ```
///
pub InvalidDropTypeSignature {
version: "next",
version: "0.27.0",
name: "invalidDropTypeSignature",
severity: Severity::Error,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ declare_lint_rule! {
/// ```
///
pub TransactionNesting {
version: "next",
version: "0.15.0",
name: "transactionNesting",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ declare_lint_rule! {
/// ## Valid in Postgres >= 11
/// alter table test add column count int not null default 0;
pub AddingRequiredField {
version: "next",
version: "0.1.0",
name: "addingRequiredField",
severity: Severity::Error,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub BanDeleteWithoutWhere {
version: "next",
version: "0.25.0",
name: "banDeleteWithoutWhere",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ declare_lint_rule! {
/// ```
///
pub BanDropColumn {
version: "next",
version: "0.1.0",
name: "banDropColumn",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ declare_lint_rule! {
///
/// Make sure that you really want to drop it.
pub BanDropDatabase {
version: "next",
version: "0.9.0",
name: "banDropDatabase",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ declare_lint_rule! {
/// alter table users alter column email drop not null;
/// ```
pub BanDropNotNull {
version: "next",
version: "0.1.0",
name: "banDropNotNull",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub BanDropSchema {
version: "next",
version: "0.25.0",
name: "banDropSchema",
severity: Severity::Error,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ declare_lint_rule! {
/// drop table some_table;
/// ```
pub BanDropTable {
version: "next",
version: "0.1.0",
name: "banDropTable",
severity: Severity::Warning,
recommended: true,
Expand Down
2 changes: 1 addition & 1 deletion crates/pgls_analyser/src/lint/destructive/ban_truncate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub BanTruncate {
version: "next",
version: "0.25.0",
name: "banTruncate",
severity: Severity::Error,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ declare_lint_rule! {
///
/// `truncate a, b;`
pub BanTruncateCascade {
version: "next",
version: "0.9.0",
name: "banTruncateCascade",
severity: Severity::Error,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare_lint_rule! {
/// ```
///
pub BanUpdateWithoutWhere {
version: "next",
version: "0.25.0",
name: "banUpdateWithoutWhere",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ declare_lint_rule! {
/// ```
///
pub ChangingColumnType {
version: "next",
version: "0.15.0",
name: "changingColumnType",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ declare_lint_rule! {
/// ```
///
pub RenamingColumn {
version: "next",
version: "0.15.0",
name: "renamingColumn",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ declare_lint_rule! {
/// ```
///
pub RenamingTable {
version: "next",
version: "0.15.0",
name: "renamingTable",
severity: Severity::Warning,
recommended: false,
Expand Down
2 changes: 1 addition & 1 deletion crates/pgls_analyser/src/lint/safety/add_serial_column.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ declare_lint_rule! {
/// ```
///
pub AddSerialColumn {
version: "next",
version: "0.17.0",
name: "addSerialColumn",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ declare_lint_rule! {
/// ```
///
pub AddingFieldWithDefault {
version: "next",
version: "0.15.0",
name: "addingFieldWithDefault",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ declare_lint_rule! {
/// ```
///
pub AddingForeignKeyConstraint {
version: "next",
version: "0.15.0",
name: "addingForeignKeyConstraint",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ declare_lint_rule! {
/// ```
///
pub AddingNotNullField {
version: "next",
version: "0.15.0",
name: "addingNotNullField",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ declare_lint_rule! {
/// ```
///
pub AddingPrimaryKeyConstraint {
version: "next",
version: "0.15.0",
name: "addingPrimaryKeyConstraint",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidAddingExclusionConstraint {
version: "next",
version: "0.25.0",
name: "avoidAddingExclusionConstraint",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidAttachingPartition {
version: "next",
version: "0.25.0",
name: "avoidAttachingPartition",
severity: Severity::Warning,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidCreateTrigger {
version: "next",
version: "0.25.0",
name: "avoidCreateTrigger",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidEnableDisableTrigger {
version: "next",
version: "0.25.0",
name: "avoidEnableDisableTrigger",
severity: Severity::Warning,
recommended: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ declare_lint_rule! {
/// ```
///
pub AvoidWideLockWindow {
version: "next",
version: "0.25.0",
name: "avoidWideLockWindow",
severity: Severity::Warning,
recommended: true,
Expand Down
2 changes: 1 addition & 1 deletion crates/pgls_analyser/src/lint/safety/ban_drop_trigger.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare_lint_rule! {
/// ```
///
pub BanDropTrigger {
version: "next",
version: "0.25.0",
name: "banDropTrigger",
severity: Severity::Warning,
recommended: false,
Expand Down
2 changes: 1 addition & 1 deletion crates/pgls_analyser/src/lint/safety/ban_vacuum_full.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare_lint_rule! {
/// ```
///
pub BanVacuumFull {
version: "next",
version: "0.25.0",
name: "banVacuumFull",
severity: Severity::Error,
recommended: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ declare_lint_rule! {
/// ```
///
pub ConstraintMissingNotValid {
version: "next",
version: "0.15.0",
name: "constraintMissingNotValid",
severity: Severity::Warning,
recommended: false,
Expand Down
Loading
Loading