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(fdr): add tags and PR links to releases data model #1489

Merged
merged 3 commits into from
Sep 17, 2024

Conversation

armandobelardo
Copy link
Contributor

@armandobelardo armandobelardo commented Sep 16, 2024

Fixes FER-3255

Short description of the changes made

This PR adds the concept of a tag to the release itself, as well as PR links to the changelog entry items

What was the motivation & context behind this PR?

  1. Wanting to enrich the changelog that we will eventually render within the docs
  2. Wanting to clarify which changes impact which users (e.g. this release was only impacting the fern definition, etc)

How has this PR been tested?

Some db ete tests

Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

7 Skipped Deployments
Name Status Preview Comments Updated (UTC)
app-dev.buildwithfern.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
app-slash.ferndocs.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
app.buildwithfern.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
app.ferndocs.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
dashboard-dev.buildwithfern.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
dashboard.buildwithfern.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm
icons.ferndocs.com ⬜️ Ignored (Inspect) Sep 17, 2024 5:37pm

Copy link

Copy link

github-actions bot commented Sep 16, 2024

📦 Next.js Bundle Analysis for fern-platform-monorepo

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page Size (compressed)
global 240.31 KB (🟢 -16.97 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Two Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/dynamic/[host]/[[...slug]] 80.42 KB 320.73 KB 91.64% (🟡 +0.94%)
/static/[host]/[[...slug]] 80.42 KB 320.73 KB 91.64% (🟡 +0.94%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

github-actions bot commented Sep 16, 2024

PR Preview

- name: asyncapi
value: "AsyncAPI"
- name: grpc
value: "gRPC"
Copy link
Member

Choose a reason for hiding this comment

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

do you think there's any benefit of structuring here? my guess is string is fine and if we want to structure we just put all of that onus on the client (seed)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call, updated

docs: |
The URL to the pull request that introduced this change. This is optional for backcompat.
You do not always need to specify the URL as the CLI can fill it in with the current PR, but given you can choose to not
release within the same PR as the change is introduced, this should be specified for divorcing the two.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to links

Copy link

@armandobelardo armandobelardo temporarily deployed to Preview - app.buildwithfern.com September 17, 2024 17:39 — with GitHub Actions Inactive
@armandobelardo armandobelardo temporarily deployed to Preview - app-dev.buildwithfern.com September 17, 2024 17:39 — with GitHub Actions Inactive
Copy link

@armandobelardo armandobelardo enabled auto-merge (squash) September 17, 2024 17:41
@armandobelardo armandobelardo merged commit 6c07651 into main Sep 17, 2024
26 of 27 checks passed
@armandobelardo armandobelardo deleted the ab/tags_n_prs branch September 17, 2024 17:44
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.

2 participants