forme-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863572f23813b5d5090e945bbfcd36d225584aa728aaed8ff1c3e7ca73e4cdd6
-  data.tar.gz: b152a91177bffc61c05cdacabc76fb85262ed70947ba831da4109baf3d435724
+  metadata.gz: 59729e8bf94118b04388c22c7c31fec173f7ab915170da01a5c0889ebd982eb5
+  data.tar.gz: 283853492512983124933700ac6d092b539de4995f21c2d0c3aeb1f30dab5481
 SHA512:
-  metadata.gz: 7e785dc05aa0846e664610eba4a013c9006731ea5b5e4295bd0b517527e70fdde7df931a6778c31b2097395630b152a98ffe8dfc85c129cb7a25dd9e3c8c7ea2
-  data.tar.gz: 8361e47d81f21658f310384205290cb6590ab1c0b663ce6543c324f16270dfdee1d1002d2bdb11ccd685757bd0b4fa7e845fb1dee2bffcf585607019016d90fc
+  metadata.gz: 9467b66b514e7ece4284f9a09cc2ccbd15189ad8b93293ebbc99442f8f5ce7bf5b2240f9f2a8e82bf41d3f025daa7fcbcbc8b9bcffdce7871daa95558eea08f0
+  data.tar.gz: 0441de602d5a2ae9175254d2d00809d3aa6ff308a6f63d11a7e9a4291802c4786a018d3ba1e832211c647bbe1fda70aa5e660b5a87fa686648ee7b9ca0e7440c

data/CHANGELOG.md

@@ -1,6 +1,48 @@
 # Changelog
 
-## 0.1.0 (unreleased)
+## 0.2.0 (2026-10-20)
+
+### Breaking
+
+- File image sources (`/`, `./`, `../`) are omitted with a warning unless the new
+  `image_root:` option names a directory containing them. Allowed files are
+  inlined after checking they are regular files of at most 64 MiB.
+- Font `weight` must be an Integer from 1 to 1000 and `italic` true or false;
+  invalid values and non-UTF-8 `css:` or font families raise `ArgumentError`.
+- `FormePDF::Rails#render_forme_pdf` is private, so Rails does not expose it as
+  a controller action. Call it from your own actions as before.
+
+### Fixed
+
+- Rendering deeply nested HTML on a non-main Ruby thread no longer overflows the
+  thread's stack and hangs the process. Renders run on a native thread with a
+  64 MiB stack, and documents nested deeper than 512 elements raise
+  `FormePDF::RenderError`.
+- Failed source builds show Cargo's diagnostics instead of only
+  "Forme native build failed".
+
+### Changed
+
+- Require Ruby 3.3 or later. The Ubuntu 24.04 package job installs a pinned
+  Ruby 3.3 build in its clean container.
+- State only platform requirements in the README and installation guide.
+- Update the native engine to Forme HTML 0.28.0 at
+  `b97dc101b705ea5d7fea6fb1b20fabfb5bd2d63d`; running headers and footers
+  no longer inherit `<body>` color and font.
+- Allow the `json` 3.x runtime dependency.
+- Refresh locked Rust and development dependencies and regenerate third-party notices.
+- Publish on a `v*` tag push instead of a manual dispatch. The release promotes
+  the tagged commit's CI packages unchanged, attaches them with `SHA256SUMS` to
+  the GitHub release, and pushes each to RubyGems with a Sigstore attestation.
+- Re-review native audit exceptions against the new engine revision.
+- CI installs the source gem on macOS as well as Linux, verifies the rustup
+  installer checksum and pins the Ubuntu test images by digest.
+
+## 0.1.0 (2026-09-18)
+
+Released on [GitHub](https://github.com/clearstackio/forme-ruby/releases/tag/v0.1.0)
+and [RubyGems](https://rubygems.org/gems/forme-ruby/versions/0.1.0)
+with identical source and native gems.
 
 ### Added
 
@@ -23,7 +65,9 @@
 
 - Forme HTML 0.24.0 at `f408920e632c59da0651b5b6d32f8c1397477673`.
 - Build toolchain: Rust 1.94.0; target minimums macOS 15 and glibc 2.28.
-- RubyGems publication and qualification of the final release commit are pending.
+- Release commit `266628a` passed the full hosted platform matrix and CodeQL.
+- Published all three packages through trusted publishing; registry downloads
+  match the qualified CI and GitHub release artifacts byte-for-byte.
 
 ### Release preparation
 

data/CONTRIBUTING.md

@@ -5,7 +5,7 @@ Use synthetic documents and assets that can be redistributed.
 
 ## Set up a checkout
 
-Use CRuby 3.2+ and Rust/Cargo 1.94.0, a native linker and make. From the repository:
+Use CRuby 3.3+ and Rust/Cargo 1.94.0, a native linker and make. From the repository:
 
 ```bash
 bundle install

data/NOTICE

@@ -1,5 +1,5 @@
 forme-ruby is an independent binding, not an official Forme project.
 Forme: https://github.com/danmolitor/forme
-Pinned revision: f408920e632c59da0651b5b6d32f8c1397477673
+Pinned revision: b97dc101b705ea5d7fea6fb1b20fabfb5bd2d63d
 Forme is MIT licensed. Native distributions must include upstream and dependency
 license notices generated during their build (see third-party notices).

data/README.md

@@ -9,18 +9,25 @@ WebAssembly or separate rendering service is needed.
 
 This is an independent MIT-licensed binding maintained by
 [ClearStack](https://github.com/clearstackio), not an official upstream project.
-**0.1.0 is in preparation; RubyGems publication is pending.**
+**[0.2.0 is available on RubyGems](https://rubygems.org/gems/forme-ruby/versions/0.2.0).**
 
 ## Getting started
 
-Until the first RubyGems release, use the Git repository and commit the resolved
-lockfile. Git installation compiles the native extension and requires Rust/Cargo
-1.94.0, a linker and make:
+Add to your Gemfile and run `bundle install`:
 
 ```ruby
-gem "forme-ruby", github: "clearstackio/forme-ruby", branch: "main", require: "forme_pdf"
+gem "forme-ruby", "~> 0.2.0", require: "forme_pdf"
 ```
 
+Or install directly:
+
+```sh
+gem install forme-ruby -v 0.2.0
+```
+
+RubyGems selects a matching native package where available. The same packages
+and checksums are available in the [GitHub release](https://github.com/clearstackio/forme-ruby/releases/tag/v0.2.0).
+
 ```ruby
 require "forme_pdf"
 
@@ -28,21 +35,14 @@ pdf = FormePDF.render_html("<h1>Hello from Ruby</h1>")
 File.binwrite("hello.pdf", pdf)
 ```
 
-Ruby 3.2 or later is required. Planned native packages target Apple Silicon macOS
-15+ and Linux AMD64 glibc 2.28+ and need no compiler. Source installs require
-network access to locked upstream dependencies. See [installation](docs/installation.md).
-
-## Native platform targets
+## Requirements
 
-| Native gem | Qualification environments |
-| --- | --- |
-| `arm64-darwin` | Apple Silicon macOS 15 and 26 |
-| `x86_64-linux-gnu` | Red Hat UBI 8, 9 and 10; Ubuntu 24.04 and 26.04; Arch Linux rolling |
+- Ruby 3.3 or later.
+- Native gems: macOS 15+ on Apple Silicon, or Linux AMD64 with glibc 2.28+.
+- Source gem: Rust/Cargo 1.94.0, a C linker, make and network access to the
+  locked upstream dependencies.
 
-These are the release CI targets; qualification of this prepared commit is
-pending. Red Hat testing uses official UBI images, not RHEL certification.
-Linux ARM64, Windows and Alpine/musl binaries are not provided. See the
-[installation guide](docs/installation.md) for Ruby and source-build requirements.
+See the [installation guide](docs/installation.md).
 
 ## Using Rails
 
@@ -65,7 +65,7 @@ Rails is optional. The [Rails guide](docs/rails.md) also covers the opt-in
 - [Release guide](docs/releasing.md): package qualification and future publication.
 - [Changelog](CHANGELOG.md), [license](LICENSE) and [third-party notices](THIRD_PARTY_LICENSES.txt).
 
-Use trusted HTML and assets. The engine can read local image paths and is not a
-sandbox for untrusted documents. See [security](SECURITY.md). Report reproducible
+Use trusted HTML and assets. Local image files are read only inside an explicit
+`image_root:`, and the engine is not a sandbox for untrusted documents. See [security](SECURITY.md). Report reproducible
 bugs through [GitHub issues](https://github.com/clearstackio/forme-ruby/issues)
 with synthetic input, Ruby/platform versions and renderer diagnostics.

data/SECURITY.md

@@ -1,7 +1,9 @@
 # Security
 
-Render trusted HTML and caller-selected assets only. Forme can read local image
-paths and consumes CPU/memory in the host process. It is not an HTML sandbox;
+Render trusted HTML and caller-selected assets only. Local image files are read
+only inside a caller-supplied `image_root:`, at most 64 MiB each. Rendering
+consumes CPU/memory in the host process, and some layouts, such as deeply nested
+tables, can take far longer than their size suggests. It is not an HTML sandbox;
 thread cancellation is not a reliable rendering timeout.
 
 Keep confidential documents out of logs and public issue attachments. Use a
@@ -9,9 +11,6 @@ minimal synthetic reproduction when reporting a problem. Send potential
 security vulnerabilities privately to ajaya@clearstack.io rather than posting
 sensitive details publicly. No response-time guarantee is offered.
 
-The initial 0.1.0 release is still in preparation. Before deployment, qualify the
-exact package and pinned native dependencies on your application's target.
-
 Dependency audit exceptions and their call-path evidence are recorded in
 [the security review](docs/security-exceptions.md). They must be re-reviewed
 when the pinned engine or public native interface changes.

data/THIRD_PARTY_LICENSES.txt

@@ -3236,7 +3236,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-crc32fast 1.5.2 — MIT OR Apache-2.0
+crc32fast 1.5.3 — MIT OR Apache-2.0
 https://github.com/srijs/rust-crc32fast
 
                                  Apache License
@@ -6631,7 +6631,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-forme-pdf 0.24.0 — MIT
+forme-pdf 0.28.0 — MIT
 https://github.com/formepdf/forme
 
 MIT License
@@ -6658,7 +6658,7 @@ SOFTWARE.
 
 
 
-forme-pdf-html 0.24.0 — MIT
+forme-pdf-html 0.28.0 — MIT
 https://github.com/formepdf/forme
 
 MIT License
@@ -8240,7 +8240,7 @@ SOFTWARE.
 
 
 
-lazy_static 1.5.0 — MIT OR Apache-2.0
+lazy_static 1.5.1 — MIT OR Apache-2.0
 https://github.com/rust-lang-nursery/lazy-static.rs
 
                               Apache License
@@ -8446,8 +8446,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 
-Copyright (c) 2010 The Rust Project Developers
-
 Permission is hereby granted, free of charge, to any
 person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the
@@ -8474,7 +8472,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-libc 0.2.189 — MIT OR Apache-2.0
+libc 0.2.191 — MIT OR Apache-2.0
 https://github.com/rust-lang/libc
 
                               Apache License
@@ -16370,7 +16368,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-serde_json 1.0.151 — MIT OR Apache-2.0
+serde_json 1.0.154 — MIT OR Apache-2.0
 https://github.com/serde-rs/json
 
                               Apache License
@@ -17074,7 +17072,7 @@ SOFTWARE.
 
 
 
-siphasher 1.0.3 — MIT/Apache-2.0
+siphasher 1.0.4 — MIT OR Apache-2.0
 https://github.com/jedisct1/rust-siphash
 
 Copyright 2012-2016 The Rust Project Developers.
@@ -17087,7 +17085,230 @@ option.
 
 
 
-smallvec 1.16.1 — MIT OR Apache-2.0
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+
+smallvec 1.16.3 — MIT OR Apache-2.0
 https://github.com/servo/rust-smallvec
 
                               Apache License
@@ -18291,7 +18512,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-syn 3.0.6 — MIT OR Apache-2.0
+syn 3.0.9 — MIT OR Apache-2.0
 https://github.com/dtolnay/syn
 
                               Apache License
@@ -18732,7 +18953,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-thiserror 2.0.20 — MIT OR Apache-2.0
+thiserror 2.0.21 — MIT OR Apache-2.0
 https://github.com/dtolnay/thiserror
 
                               Apache License
@@ -18939,7 +19160,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-thiserror-impl 2.0.20 — MIT OR Apache-2.0
+thiserror-impl 2.0.21 — MIT OR Apache-2.0
 https://github.com/dtolnay/thiserror
 
                               Apache License
@@ -20768,7 +20989,7 @@ SOFTWARE.
 
 
 
-unicode-ident 1.0.26 — (MIT OR Apache-2.0) AND Unicode-3.0
+unicode-ident 1.0.27 — (MIT OR Apache-2.0) AND Unicode-3.0
 https://github.com/dtolnay/unicode-ident
 
                               Apache License
@@ -23307,7 +23528,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-zerocopy 0.8.57 — BSD-2-Clause OR Apache-2.0 OR MIT
+zerocopy 0.8.63 — BSD-2-Clause OR Apache-2.0 OR MIT
 https://github.com/google/zerocopy
 
                                  Apache License
@@ -23569,7 +23790,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-zerocopy-derive 0.8.57 — BSD-2-Clause OR Apache-2.0 OR MIT
+zerocopy-derive 0.8.63 — BSD-2-Clause OR Apache-2.0 OR MIT
 https://github.com/google/zerocopy
 
                                  Apache License
@@ -23831,7 +24052,7 @@ DEALINGS IN THE SOFTWARE.
 
 
 
-zeroize 1.9.0 — Apache-2.0 OR MIT
+zeroize 1.9.1 — Apache-2.0 OR MIT
 https://github.com/RustCrypto/utils
 
 

data/docs/github-setup.md

@@ -9,7 +9,7 @@ RubyGems settings a maintainer must enable. These instructions prepare
 The repository includes an MIT license, contributor and security guides, issue
 forms, a pull-request template, CODEOWNERS, Dependabot, CodeQL, dependency review,
 and build/release workflows. Actions are pinned to full commit SHAs; Dependabot
-proposes updates. CI runs on pull requests, main pushes and a weekly schedule.
+proposes updates. CI runs on pull requests, master pushes and a weekly schedule.
 PR jobs do not receive publishing credentials. Checkout does not persist tokens.
 
 ## Configure GitHub after an authorized push
@@ -20,7 +20,7 @@ PR jobs do not receive publishing credentials. Checkout does not persist tokens.
    graph, Dependabot alerts, secret scanning and push protection where available.
    CodeQL is provided as an advanced workflow for Ruby, Rust and GitHub Actions; do not also enable
    CodeQL default setup.
-3. After the first successful run, protect `main` with a ruleset requiring pull
+3. After the first successful run, protect `master` with a ruleset requiring pull
    requests, one approving review, resolved conversations, current branches and
    the `CI required`, CodeQL matrix and dependency-review checks. Select the
    actual check names from GitHub. Block deletion and force pushes. Require code
@@ -28,26 +28,28 @@ PR jobs do not receive publishing credentials. Checkout does not persist tokens.
    pull requests can be reviewed. Do not silently bypass review to unblock them.
 4. Allow only reviewed Actions, keep the default workflow token read-only, and
    disable Actions creating or approving pull requests. Keep fork approval on.
-5. Create environment `rubygems`, restrict deployment to `main`, and configure a
+5. Create environment `rubygems`, restrict deployment to `v*` tags, and configure a
    trusted maintainer as required reviewer with self-review prevented. Confirm
    an eligible second reviewer exists before enabling this requirement.
 6. Configure RubyGems trusted publishing exactly as [releasing](releasing.md)
    specifies. Do not store a long-lived publishing key in repository secrets.
 
-The existing remote has older history. The prepared local root commit replaces
-that history only after explicit authorization and consumer coordination. Enable
-force-push protection after that authorized initial transition. A backup local
-branch preserves the prior history. Never force-push just to make CI pass.
+The authorized initial history consolidation is complete. Remote branch
+`archive/pre-0.1.0-squash` preserves the old consumer pin. The `rubygems`
+environment deploys only from `v*` tags (it allowed the default branch for the manual 0.1.0
+release). RubyGems trusted publishing successfully published 0.1.0. A second reviewer remains a
+separate repository setup task.
+Never force-push just to make CI pass.
 
 ## Release evidence
 
-`CI required` fails if any Ruby test, package build, distribution installation or
+`CI required` fails if any Ruby test, package build, package installation or
 audit fails or is skipped. Linux packages are built against glibc 2.28 and checked
 for newer symbol requirements. Compatibility jobs install the same artifact,
-not a newly rebuilt library. Rolling Arch is deliberately retested weekly.
+not a newly rebuilt library.
 
-The manual release workflow accepts only a successful CI run from this repository,
-for the exact main commit. It validates package names, versions, platforms and
+The tag-triggered release workflow accepts only a successful CI run from this
+repository, for the exact master commit the tag points to. It validates package names, versions, platforms and
 license files before trusted publication, and records an attestation for the
 promotion workflow. Keep the successful CI URL with release notes. GitHub
 settings, hosted matrix success and RubyGems setup must be confirmed separately;