Merge pull request #2244 from lucab/ups/docs-release-guide

templates: add release-checklist

Merge pull request #2243 from lucab/ups/workflow-checkout

workflow/release: further refinements

templates: add release-checklist

This collects all release steps in a release-checklist template.

workflow/release: further refinements

This tweaks the release GH workflow further so that it only triggers
when the `configure.ac` file (which owns the version) changes.
Plus it properly checkouts the PR branch to avoid wrongly looking
at a synthetic merge commit.

Merge pull request #2242 from stb-tester/tarball-import-xattrs

ostree commit --tree=tar: Import xattrs from tarballs

ostree commit --tree=tar: Import xattrs from tarballs

If you specify an `xattr_callback` the xattrs will still be taken from
there for now.

Merge pull request #2241 from lucab/release-2020.8

Release 2020.8

configure: post-release version bump

Release 2020.8

Merge pull request #2240 from lucab/ups/ci-pr-title

workflows/release: pattern-match on PR title

workflows/release: pattern-match on PR title

This adds an additional condition in order to run sanity check all
PRs starting with `Release` (case-insensitive).

Merge pull request #2239 from lucab/ups/gh-actions

ci: run ci-release-build.sh on GitHub

ci: run ci-release-build.sh on GitHub

This adds a GitHub action in order to run ci-release-build.sh on
release PRs (detected via the `kind/release` label).

Merge pull request #2232 from cgwalters/deploy-docs

deployment: Add a bunch of docs and fix annotations

Merge pull request #2235 from cgwalters/checkout-some-new-style

bin/checkout: Port some to new style

Merge pull request #2231 from cgwalters/some-nullable-annotations

deployment: Ensure query_deployments_for returns nullable values

deployment: Ensure query_deployments_for returns nullable values

Since that's a common case; hit this while working on rpm-ostree
code using the ostree-rs bindings.

deployment: Add a bunch of docs and fix annotations

We were missing docs for these, also add some nullability annotations.
Motivated by using these from the Rust bindings.

bin/checkout: Port some to new style

I was reading this code for unrelated reasons and noticed it
was still old style; port most (but not all) to new style.

Merge pull request #2236 from lucab/ups/travis-xenial

ci/travis: move to newer base distro

ci/travis: move to newer base distro

This removes the old pinned distro (Ubuntu Trusty 14.04) from Travis,
moving to the newer default distro (Ubuntu Xenial 16.04).

Merge pull request #2233 from cgwalters/repo-annotations

sysroot: Fix up some GI nullable annotations

sysroot: Fix up some GI nullable annotations

Hit `ostree_sysroot_repo()` shouldn't be nullable while using
the ostree Rust bindings.

Merge pull request #2228 from jlebon/pr/drop-volatile

Drop use of `volatile`

Merge pull request #2230 from alexlarsson/pull-dont-save-passed-in-summary

pull: Don't save into cache passed in GByte summaries

Merge pull request #2229 from dbnicholson/static-delta-generate-annotations

lib/deltas: Annotate from checksum as nullable

pull: Don't save into cache passed in GByte summaries

The cache shouldn't be affected by the user passing in some other
summary as it may not be the "official one".

I ran into this in flatpak where the passed summary was correct, but
the re-saving of the cache updated the mtime of the cached file which
led to later http If-Modified-Since calls failing to update.

lib/deltas: Annotate from checksum as nullable

Without this you can't create a scratch delta from GI. While here,
switch the deprecated allow-none annotations to nullable.

Drop use of `volatile`

As detailed in
gitlab.gnome.org/GNOME/glib/-/issues/600#note_877282, volatile
isn't actually needed in these contexts because the atomic operations
already give us strong enough guarantees. In GCC 11, this triggers a
diagnostic due to the volatile qualifier getting dropped anyway.

There is a WIP to do the same in glib:
https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1719

This obsoletes this downstream patch:
https://src.fedoraproject.org/rpms/ostree/c/b8c5a6fb

Merge pull request #2226 from alexlarsson/fix-gir-arg

ostree_repo_gpg_sign_data: Fix API doc argument name

ostree_repo_gpg_sign_data: Fix API doc argument name

I got:
src/libostree/ostree-repo.c:5232: Warning: OSTree: ostree_repo_gpg_sign_data: unknown parameter 'out_signature' in documentation comment, should be 'out_signatures'

Merge pull request #2224 from stb-tester/bootloader-refactorings

Bootloader probing and construction refactoring

Merge pull request #2225 from jlebon/pr/clear-timer

lib/fetch-curl: Unref timeout source

lib/fetch-curl: Unref timeout source

The timeout timer should always be one-shot, so let's just always
destroy it in the callback. The main context has its own ref on it, so
it won't be freed behind its back.

This *should* fix a leak that was brought up in
https://bugzilla.redhat.com/show_bug.cgi?id=1891761.

Reported-by: Milan Crha <mcrha@redhat.com>

lib/fetcher-curl: Use G_SOURCE_REMOVE instead of FALSE

They're equivalent, though I prefer the former because it's more
descriptive and it makes it really obvious that it's a `GSource`
callback.

fixup! Refactor `ostree_sysroot_query_bootloader`

fixup! Refactor: Centralise choosing the appropriate bootloader

Tests: Refactor bootloader-entries-crosscheck

I've made this use functions to make it easier to add support for more
bootloaders.  Seeing as there will be a big diff anyway I've also adjusted
the formatting to make it pep8 compliant.

Refactor `ostree_sysroot_query_bootloader`

This is more regular, so will make it easier to add more bootloader types
in the future.

Add support for explicitly requesting any specific bootloader type

...with the `sysroot.bootloader` configuration option.  This can be useful
when converting a system to use `ostree` which doesn't currently have a
bootloader configuration that `ostree` can automatically detect, and is
also useful in combination with the `--sysroot` option when provisioning a
rootfs for systems other than the one you're running `ostree admin deploy`
on.

Refactor: sysroot.bootloader: Store enum value rather than string

It's easier to extend and it centralises the config parsing.  In other
places we will no longer need to use `g_str_equal` to match these values,
a `switch` statement will be sufficient.

Refactor: Centralise choosing the appropriate bootloader

In preparation for enhancing `_ostree_sysroot_query_bootloader`

ostree_repo_get_bootloader: Document transfer none

I think this may affect bindings too.

Merge pull request #2188 from alexlarsson/delta-indexes

Add indexes for deltas outside of the summary

ostree pull: Add more g_debug spew around fetching deltas

This is useful to debug what is happening when downloading via deltas.

Add ostree_repo_gpg_sign_data()

This is similar to ostree_sign_data() but for the old gpg code.
Flatpak will need this to reproduce a signed summary.

tests: Add a testcase to ensure we're not using the summary if we don't need it

With deltas outside the summary, if a commit is specified when pulling
we don't download the summary. Verify this.

pull: Only download summary if we need it for the pull operation

If we have a commit id for all the refs we're pulling, and if we
don't need the summary to list all the refs when mirroring then the
only reason to download the summary is for the list of deltas.

With the new "indexed-deltas" property in the config file (and mirrored
to the summary file) we can detect when we don't need the summary for
deltas and completely avoid downloading it then.

deltas: Set `indexed-deltas` key in the config and summary

Clients can use these during pull and avoid downloading the summary if
needed, or use the indexed-deltas instead of relying on the ones in
the summary which may be left out.

deltas: Take a shared repo lock while reindexing deltas

This ensures we're not racing with a prune operation that can be removing
the delta indexes we're relying on.

deltas: Add tests for delta indexes

This tests generation of the index as well as using it when pulling

deltas: Use delta indexes when pulling

If there is no delta index in the summary, try to fetch the
delta index for the commit we're going to and use that to find the
delta (if any).

deltas: Add CLI ops to list and reindex delta-indexes

deltas: Make ostree_repo_static_delta_reindex() public

It is useful to be able to trigger this without having to regenerate
the summary. For example, if you are not using summaries, or ar generating
the summaries yourself.

deltas: Add and document no-deltas-in-summary config option

By default this is FALSE to keep existing clients working.

deltas: Update delta indexes when updating summary

When we update the summary file (and its list of deltas) we also update
all delta indexes. The index format is a single `a{sv}` variant identical
to the metadata-part of the summary with (currently) only the
`ostree.static-deltas` key.

Since we expect most delta indexes to change rarely, we avoid
unnecessary writes when reindexing. New indexes are compared to
existing ones and only the changed ones are written to disk.  This
avoids unnecessary write load and mtime changes on the repo server.

deltas: Add ostree_repo_list_static_delta_indexes() function

This lists all the available delta indexes.

deltas: Add _ostree_get_relative_static_delta_index_path()

This gets the subpath for a delta index file, which is of the form
"delta-indexes/$commit.index", that contains all the deltas going
to the particular commit.

Merge pull request #2205 from pwithnall/etags-and-last-modified

Add support for ETag and Last-Modified headers for summary and summary.sig

tests: Split RFC 2616 date parsing code out and add tests

This makes it testable, and increases its test coverage too 100% of
lines, as measured by `make coverage`.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

ostree/trivial-httpd: Add Last-Modified/ETag support

This is basic support for the
Last-Modified/ETag/If-Modified-Since/If-None-Match headers. It’s not
high performance, and doesn’t support all of the related caching
features (like the If-Match header, etc.).

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

tests: Add simple test for summary file caching

This test would have actually passed before the summary file caching
changes (in the previous few commits) were added, as the `summary.sig`
essentially acted as the ETag for the summary file, and itself wasn’t
updated on disk if it didn’t change when querying the server.

Actually testing that the HTTP caching headers are working to reduce
HTTP traffic would require test hooks into the pull code or the
trivial-httpd server, neither of which I have the time to add at the
moment.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

lib/pull: Hook up HTTP caching headers for summary and summary.sig

As `summary` and `summary.sig` aren’t immutable, HTTP requests to
download them can be optimised by sending the `If-None-Match` and
`If-Modified-Since` headers to avoid unnecessarily re-downloading them
if they haven’t changed since last being checked.

Hook them up to the new support for that in the fetcher.

The `ETag` and `Last-Modified` for each file in the cache are stored as
the `user.etag` xattr and the mtime, respectively. For flatpak, for
example, this affects the cached files in
`~/.local/share/flatpak/repo/tmp/cache/summaries`.

If xattrs aren’t supported, or if the server doesn’t support the caching
headers, the pull behaviour is unchanged from before.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

libostree: Add support for ETag and Last-Modified headers

Add support in the soup and curl fetchers to send the `If-None-Match`
and `If-Modified-Since` request headers, and pass on the `ETag` and
`Last-Modified` response headers.

This currently introduces no functional changes, but once call sites
provide the appropriate integration, this will allow HTTP caching to
happen with requests (typically with metadata requests, where the data
is not immutable due to being content-addressed). That should reduce
bandwidth requirements.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Merge pull request #2222 from fkrull/patch-v2020.7

lib: add missing GI annotation

Merge pull request #2221 from kelvinfan001/fix-docs

docs: Fix various typos

docs: Fix various typos

lib: fix GI parameter tags

Merge pull request #2219 from jlebon/pr/fix-inode-print-format

ostree-prepare-root: print st_dev and st_ino as 64-bit ints

Merge pull request #2218 from cgwalters/travis-32bit

travis: Add a 32 bit build

ostree-prepare-root: print st_dev and st_ino as 64-bit ints

This matches what systemd does and should work fine on all platforms.

Possibly resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1888436

travis: Add a 32 bit build

In the past we've had 32 bit bugs that were caught by
the compiler, let's add this to Travis.

Merge pull request #2215 from cgwalters/fd-transfer

deploy: Remove (transfer none) from fd arg

Merge pull request #2214 from cgwalters/release-2020-7

Release 2020.7

deploy: Remove (transfer none) from fd arg

GI complains.  And in general one needs to assume that file
descriptors aren't stolen.

Post-release version bump

Release 2020.7

Merge pull request #2213 from alexlarsson/summary-bugfixes

Various fixes from the indexed-summaries branch

signatures: Fix leak in _sign_detached_metadata_append()

This needs to ref_sink the returned variant, as it is used with g_autoptr
in the callers.

fetch_summary_with_options: Fix n-network-retries option parsing

"&u" is not a valid gvariant format string, it should just be "u".

ostree_repo_find_remotes_async: Fix leak of summary

We were creating a GVariant from a GBytes and storing it in an
g_autoptr without ref_sinking it.

Merge pull request #2212 from jlebon/pr/packit-tweak

ci: Make Packit ignore downstream patches

Merge pull request #2211 from jlebon/pr/close-fd

lib/deploy: Don't leak fd when checksumming dtbs

ci: Make Packit ignore downstream patches

We don't really carry "Fedora-only" patches in dist-git. So we want to
nuke all the patches which exist there.

Follow-up to #2210.

lib/deploy: Don't leak fd when checksumming dtbs

Likely the root of https://bugzilla.redhat.com/show_bug.cgi?id=1886149.

Merge pull request #2210 from jlebon/pr/packit

Add Packit integration

Add Packit integration

This is a basic `.packit.yaml` integration file which will allow us have
continuous builds of OSTree in cosa and upstream CI. If things go well,
we'll likely deploy this in other build tools like rpm-ostree.

Prompted by wanting to get #2155 out to unblock
https://github.com/coreos/rpm-ostree/pull/2170.

Merge pull request #2198 from cgwalters/no-hardlink-zerosize

checkout: Don't hardlink zero sized files

Merge pull request #2209 from travier/docs-fixup

docs: Fix URL in Jekyll _config.yml

docs: Fix URL in Jekyll _config.yml

Merge pull request #2208 from cgwalters/bump-libglnx

libglnx: Bump to master

Merge pull request #2207 from travier/docs

docs: Add GitHub Pages support

libglnx: Bump to master

To pull in the fix for `/var/tmp` on NixOS but also
on general principle.

Update submodule: libglnx

```
Colin Walters (1):
      xattrs: Add better error prefixing

Rebecca Turner (2):
      glnx-fdio: try $TMPDIR if /var/tmp doesn't exist
      glnx-fdio: use $TMPDIR if set
```

Merge pull request #2155 from jlebon/pr/add-initrds

lib/deploy: Add support for overlay initrds

README: Update and mention new docs

docs: Move historical README to the docs

docs: Move and update pages from the manual

docs: Update Contributing and tutorial pages

checkout: Don't hardlink zero sized files

Alternative to https://github.com/ostreedev/ostree/pull/2197

Python's (usually) zero-sized `__init__.py` files can provoke
us hitting the hardlink limits on some filesystems (`EMLINK`).
At least one Fedora rpm-ostree user hit this.

The benefits of hardlinking here are quite marginal; lots
of hardlinks can behave suboptimally in particular filesystems
like BTRFS too.

This builds on prior code which made this an option, introduced
in https://github.com/ostreedev/ostree/commit/673cacd633f9d6b653cdea530657d3e780a41bbd
Now we just do it uncondtionally.

Also this provoked a different bug in a very obscure user mode checkout
case; when the "real" permissions were different from the "physical"
permissions, we would still hardlink.  Fix the test case for this.

Merge pull request #2167 from pwithnall/2165-dont-download-config

Avoid need to download remote config when pulling