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

chore: Generated documentation now uses a static copyright notice to avoid noisy diffs #530

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

robmaceachern
Copy link
Member

@robmaceachern robmaceachern commented Feb 29, 2024

Generated documentation now uses a static copyright notice to avoid noisy diffs.

In the past, running Scripts/generate_docs.sh would generate a huge diff as every page footer would update the timestamp to the latest day (example: #529).

This should make it much easier to diff real doc changes and prevent a lot of noise from showing up.

Checklist

Please do the following before merging:

  • Wait for 15.0.2 release to land before merging (this is currently targeting that branch to avoid merge conflicts).
  • Ensure any public-facing changes are reflected in the changelog. Include them in the Main section.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The actual changes are in this file.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhhh, thank you so much! I always wondered how to fix this...

Base automatically changed from @nsillik/release-15.0.2 to main February 29, 2024 14:55
@@ -185,7 +185,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2024 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2024-02-29)</p>
<p>&copy; Square, Inc. All rights reserved.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
Copy link
Member Author

@robmaceachern robmaceachern Feb 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: The jazzy version (jazzy ♪♫ v0.14.4) is still dynamic and will cause mass updates any time Jazzy is updated but that should be relatively infrequent (and a version bump may cause other changes anyways).

It looks like we could pass in a JAZZY_FAKE_VERSION environment var to make it static, if we really wanted to.

@robmaceachern robmaceachern requested a review from a team February 29, 2024 14:58
Copy link
Collaborator

@nsillik nsillik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, gorm

@robmaceachern robmaceachern merged commit 1bc42a2 into main Feb 29, 2024
4 checks passed
@robmaceachern robmaceachern deleted the robmaceachern/static-copyright branch February 29, 2024 21:44
kyleve added a commit that referenced this pull request Aug 1, 2024
* origin/main:
  Prepare 14.3.0 (#540)
  Custom Update Animations (#539)
  Update version to 14.2.0
  Prepare 14.2.0 release, which contains a Blueprint update
  Bumping versions to 14.1.0 (#535)
  reorder control now proxies accessibility into a seperate element (#533)
  Prepare 14.0.3
  Fix a crash that could occur during cell reuse if a list contained different types of headers. The wrong ObjectIdentifier was being compared and stored.
  Get a repro for the reordering crash reported in #market-ios
  chore: Generated documentation now uses a static copyright notice to avoid noisy diffs (#530)
  Bumping versions to 15.0.2
  fix: Fix tap gesture swallowing touches in swipe actions view
  Bump to 14.0.1
  Fix SPM Blueprint dependency
  Release 14.0.0, update BlueprintUI to 3.0.0 (#525)
  chore: iOS 15 deployment target bump [UI-5187] (#524)
  chore: Bump CI to Xcode 15.1. Bump gems. [UI-5186] (#523)
  fix: don't cancel touches in view for tap gesture recognizer
  Revert weak change
  Revert "Revert "Supplementary Tracking Fixes (#433)""
kyleve added a commit that referenced this pull request Aug 6, 2024
…rovements

* origin/main: (33 commits)
  Prepare 14.3.0 (#540)
  Custom Update Animations (#539)
  Update version to 14.2.0
  Prepare 14.2.0 release, which contains a Blueprint update
  Bumping versions to 14.1.0 (#535)
  reorder control now proxies accessibility into a seperate element (#533)
  Prepare 14.0.3
  Fix a crash that could occur during cell reuse if a list contained different types of headers. The wrong ObjectIdentifier was being compared and stored.
  Get a repro for the reordering crash reported in #market-ios
  chore: Generated documentation now uses a static copyright notice to avoid noisy diffs (#530)
  Bumping versions to 15.0.2
  fix: Fix tap gesture swallowing touches in swipe actions view
  Bump to 14.0.1
  Fix SPM Blueprint dependency
  Release 14.0.0, update BlueprintUI to 3.0.0 (#525)
  chore: iOS 15 deployment target bump [UI-5187] (#524)
  chore: Bump CI to Xcode 15.1. Bump gems. [UI-5186] (#523)
  fix: don't cancel touches in view for tap gesture recognizer
  fix: don't cancel touches in view for tap gesture recognizer
  Revert weak change
  ...
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.

3 participants