Skip to content
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

Sync/release/3.12.1 #1038

Merged
merged 19 commits into from
Dec 9, 2024
Merged

Sync/release/3.12.1 #1038

merged 19 commits into from
Dec 9, 2024

Conversation

barthisrael
Copy link
Contributor

No description provided.

barthisrael and others added 19 commits December 4, 2024 13:17
This issue was identified while working on BAR-289. The `linter.yml`
had a failure because of wrong formatting in the configuration file
for Isort. Turns out it was defined using `toml` syntax instead of
`configparser` syntax.

This commit fixes that oversight.

References: BAR-315.

Signed-off-by: Israel Barth <[email protected]>
This issue was identified while working on BAR-289. The `linter.yml`
is using a `.flake8` file which contains a set of configuration "A",
while `tox` is using a `tox.ini` file which contains another set of
configuration "B".

This commit fixes that oversight. Now both `super-linter` and `tox`
will use the very same `tox.ini`, so we have a single source of
truth for the Flake8 configuration.

References: BAR-315.

Signed-off-by: Israel Barth <[email protected]>
This commit fixes the following issues reported by `shellcheck`:

```text
In .github/foundation/security/scan-hooks.sh line 10:
          source .venv/bin/activate
                 ^----------------^ SC1091 (info): Not following: .venv/bin/activate: openBinaryFile: does not exist (No such file or directory)

  In doc/build/build line 44:
  cp -va *.html *.pdf "${DISTDIR}"
         ^-- SC2035 (info): Use ./*glob* or -- *glob* so names with dashes won't become options.
                ^-- SC2035 (info): Use ./*glob* or -- *glob* so names with dashes won't become options.

  In scripts/release.sh line 22:
  BASE="$(dirname $(cd $(dirname "$0"); pwd))"
                  ^------------------------^ SC2046 (warning): Quote this to prevent word splitting.
                       ^-------------^ SC2046 (warning): Quote this to prevent word splitting.

  In scripts/release.sh line 27:
  if ! git tag -s -m "Release ${VERSION}" release/${VERSION}
                                                  ^--------^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
  if ! git tag -s -m "Release ${VERSION}" release/"${VERSION}"

  In scripts/set-version.sh line 24:
  BASE="$(dirname $(cd $(dirname "$0"); pwd))"
                  ^------------------------^ SC2046 (warning): Quote this to prevent word splitting.
                       ^-------------^ SC2046 (warning): Quote this to prevent word splitting.

  In scripts/set-version.sh line 63:
      if [ "$1" == false ]
                ^-- SC3014 (warning): In POSIX sh, == in place of = is undefined.

  In scripts/set-version.sh line 70:
      echo $release_date
           ^-----------^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
      echo "$release_date"

  In scripts/set-version.sh line 76:
  release_date=$(get_date $DATE)
                          ^---^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
  release_date=$(get_date "$DATE")

  In scripts/set-version.sh line 111:
  if branch=$(git symbolic-ref --short -q HEAD) && [ $branch = 'master' ]
                                                     ^-----^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
  if branch=$(git symbolic-ref --short -q HEAD) && [ "$branch" = 'master' ]

  In scripts/set-version.sh line 138:
  if [ "$DOCKER" == true ]
                 ^-- SC3014 (warning): In POSIX sh, == in place of = is undefined.

  In sphinx/generate_docs.sh line 20:
  BASEDIR=$(cd ${0%/*}; pwd )
            ^--------^ SC2164 (warning): Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
               ^-----^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
  BASEDIR=$(cd "${0%/*}" || exit; pwd )

  In sphinx/generate_docs.sh line 78:
      printf "${RED}${1}${RSET}
  "
             ^-------------------^ SC2059 (info): Don't use variables in the printf format string. Use printf '..%s..' "$foo".

  In sphinx/generate_docs.sh line 89:
          --)
          ^-- SC2214 (warning): This case is not specified by getopts.

  In sphinx/generate_docs.sh line 104:
      BARMAN_DIR=$(cd "$BASEDIR/.."; pwd)
                   ^--------------^ SC2164 (warning): Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

  Did you mean:
      BARMAN_DIR=$(cd "$BASEDIR/.." || exit; pwd)

  In sphinx/generate_docs.sh line 106:
      BARMAN_DIR=$(cd "$1"; pwd)
                   ^-----^ SC2164 (warning): Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

  Did you mean:
      BARMAN_DIR=$(cd "$1" || exit; pwd)

  In sphinx/generate_docs.sh line 113:
  cd "${BASEDIR}"
  ^-------------^ SC2164 (warning): Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

  Did you mean:
  cd "${BASEDIR}" || exit

  In sphinx/generate_docs.sh line 120:
  ls "${BASEDIR}"/docs/*.rst | grep -v 'index.rst$' | xargs -trI X rm -f X
  ^-- SC2010 (warning): Don't use ls | grep. Use a glob or a for loop with a condition to allow non-alphanumeric filenames.

  In sphinx/generate_docs.sh line 127:
  make ${GEN_MODE}
       ^---------^ SC2086 (info): Double quote to prevent globbing and word splitting.

  Did you mean:
  make "${GEN_MODE}"
```

References: BAR-315.

Signed-off-by: Israel Barth <[email protected]>
This commit fixes the following issue reported by `markdownlint`:

```text
INSTALL.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Barman INSTALL instructions"]
```

Besides that, it configures `super-linter` to skip Markdown files under
`doc/` and `sphinx/` directories. Those directories contain the source
code for the current Barman documentation, which is going to be
replaced soon.

References: BAR-315.

Signed-off-by: Israel Barth <[email protected]>
We run super-linter through linter.yml, which also runs
Flake8.

So, we don’t need a dedicated flake8 job in `main.yml`.

References: BAR-459

Signed-off-by: Andre <[email protected]>
Makes the man pages build date configurable. This is required as we are
now going to perform the pre-release, which includes building the docs,
a few days before the actual release date.

References: BAR-482

Signed-off-by: Gustavo William <[email protected]>
This reverts commit 77809d0.

References: bar-494

Signed-off-by: Giulio Calacoci <[email protected]>
This reverts commit b6baaf3.

References: bar-494

Signed-off-by: Giulio Calacoci <[email protected]>
This patch modifies the json output of the infofile object
adding two new fields: `begin_time_iso` and `end_time_iso`.
The new fields allow the use of a more standard and timezone aware
time format, preserving compatibility with previous versions.

Is worth noting that in the future the iso format for dates will be the
standard used by barman for storing dates and will be used everywhere
non human readable output is requested.

References: bar-494

Signed-off-by: Giulio Calacoci <[email protected]>
References: bar-494

Signed-off-by: Giulio Calacoci <[email protected]>
We have previously added documentation for the new `--keep-compression`
flag of `barman-wal-restore`, but we missed updating the command
synopsis.

This commit fixes that oversight.

References: BAR-476.

Signed-off-by: Israel Barth <[email protected]>
…-cloud-wal-archive`

The docs were missing the addition of `--xz`, `--zstd` and `--lz4`
to `barman-cloud-wal-archive`.

Besides that, the synopsis of that command was not accurately
representing that the compression flags form a mutually exclusive
group.

This commit fixes those oversights.

References: BAR-477.

Signed-off-by: Israel Barth <[email protected]>
Co-authored-by: Gustavo William <[email protected]>
When we introduced the feature of AWS snapshot locking to Barman, we
updated only the documentation of `barman-cloud-backup`, and we missed
updating the configuration reference, which covers the snapshot backups
taken through `barman backup` command.

This commit fixes that oversight.

References: BAR-478.

Signed-off-by: Israel Barth <[email protected]>
The docs were missing the addition of `--md5` to `barman-wal-archive`.
This commit fixes that oversight.

References: BAR-475.

Signed-off-by: Israel Barth <[email protected]>
Co-authored-by: Andre Marchesini <[email protected]>
The `--tags` tags apply to all files uploaded to the cloud storage,
not only to WAL files. Also, it applies to snapshots, if creating
snapshots instead of low-level base backups.

References: BAR-479.

Signed-off-by: Israel Barth <[email protected]>
Co-authored-by: Andre Marchesini <[email protected]>
We were missing release notes for the change from ctime to ISO format
when producing JSON output for Barman cloud.

This commit fixes that oversight.

References: BAR-488 BAR-316.

Signed-off-by: Israel Barth <[email protected]>
A contribution was received from the community to fix an oversight in
the usage of `pg_has_role` in Barman. However, an entry in the release
notes of Barman 3.12.0 was missing.

This commit fixes that oversight in the release notes.

References: BAR-489.

Signed-off-by: Israel Barth <[email protected]>
Signed-off-by: Israel Barth <[email protected]>
@barthisrael barthisrael requested a review from a team as a code owner December 9, 2024 11:57
@barthisrael barthisrael merged commit ebffcd3 into master Dec 9, 2024
13 checks passed
@barthisrael barthisrael deleted the sync/release/3.12.1 branch December 9, 2024 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants