FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Feature/Release Notes - Added to Home Page under What's New by Wright4i · Pull Request #26 · codefori/docs · GitHub

/ docs Public

Feature/Release Notes - Added to Home Page under What's New - #26

Open
Wright4i wants to merge 6 commits into
codefori:mainfrom
Wright4i:feat/release-notes
Open

Feature/Release Notes - Added to Home Page under What's New#26
Wright4i wants to merge 6 commits into
codefori:mainfrom
Wright4i:feat/release-notes

Conversation

Copy link
Copy Markdown
Contributor

Link to demo site: https://wright4i.github.io/docs/

Uses GitHub API to grab details of a public repo (vscode-ibmi)

Home Page

  • Dynamic latest version number
  • Only link to Release Notes. I felt like it didn't need to be a sidebar item - thoughts?

Release Notes

  • Dynamically pulls latest 5 releases. githubAPI.ts's fetchFromGithub() has a default limit: number = 5 so we can adjust to taste.
  • Button at bottom linking to release page for vscode-ibmi

Packages added to project

Server side only, no performance impact

dotenv

Reason - Best practices. Needed .env files for API_GITHUB_TOKEN. Created .env.example for local development.

marked

Reason - Release notes from API was in markdown. marked converted to HTML so I could set the innerHTML of the astro component.

Tasks to Build on Merge

  • Needs a new GitHub API token with public_repo scope
  • Token should be added to Repository secrets as API_GITHUB_TOKEN
  • .github/workflows/astro.yml was updated to import API_GITHUB_TOKEN
  • (optional, recommended) update build workflow in vscode-ibmi to trigger build on docs so Release Notes are always current

Wright4i added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 29, 2024
Wright4i requested a review from worksofliam February 29, 2024 16:45

Copy link
Copy Markdown
Member

@Wright4i Interesting. Why is the token required? Can you not access the public API for released without a token?

Wright4i commented Feb 29, 2024
edited
Loading

Copy link
Copy Markdown
Contributor Author

@Wright4i Interesting. Why is the token required? Can you not access the public API for released without a token?

@worksofliam You'd think, but I tried and it didn't work. Guessing so they can track you for rate-limiting/abuse purposes.

Copy link
Copy Markdown
Contributor

@Wright4i @worksofliam Shouldn't we try and complete this? Would be great to have in the docs... 😍

Copy link
Copy Markdown
Contributor Author

@chrjorgensen you're right! I completely forgot this was out here open.

@worksofliam any issues with the API key usage? If not I can address the conflicts and we can get this merged in.

Copy link
Copy Markdown
Member

@Wright4i No problem with token usage! This would be cool to have.

Copy link
Copy Markdown
Member

@Wright4i I just noticed this PR and this sounds like a great addition to the docs! Several people have mentioned that they want a single spot where they can see all the new enhancements/fixes from the team and this would be a great place for that. I know it has been quite some time (2024! 😅) since this was last updated, but what do you think about reviving this PR so we can get this in? Happy to help if needed.

I was also thinking whether we could set this up to pull release notes from a couple different extensions (pretty much any repo we maintain in the Development Pack)? Maybe a dropdown or tiles to select which extension you are interested in that dynamically changes the content on the page? What do you think?

SanjulaGanepola self-requested a review January 17, 2026 00:09
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL