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

[Wright4i]

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

[worksofliam]

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

[Wright4i]

@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.

[chrjorgensen]

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

[Wright4i]

@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.

[worksofliam]

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