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

Include a way to view the changelog in Aspine #174

Closed
psvenk opened this issue Nov 17, 2020 · 5 comments · Fixed by #240
Closed

Include a way to view the changelog in Aspine #174

psvenk opened this issue Nov 17, 2020 · 5 comments · Fixed by #240
Assignees
Labels
backend Suspected problem with backend (server or scraper) bloat notrodes thinks this gets away from why people use aspine enhancement New feature or request frontend Suspected problem with frontend (client-side code in public directory)
Milestone

Comments

@psvenk
Copy link
Member

psvenk commented Nov 17, 2020

It would be nice if users could see (in a non-intrusive way) what new features have been added to Aspine. We could do this by rendering CHANGELOG.md to HTML in the backend and serving that via an endpoint which is loaded upon a button click in the info tab (after #157 is merged; that blocker is why this issue is currently on hold). In the lite version build process, we could include a step that runs a script in JS that does this compilation (we might do well to rewrite the build script entirely in JS in that case).

@psvenk psvenk added enhancement New feature or request frontend Suspected problem with frontend (client-side code in public directory) on hold Will not be worked on until further notice backend Suspected problem with backend (server or scraper) labels Nov 18, 2020
@psvenk psvenk added this to the 2.6.1 milestone Nov 29, 2020
@tektaxi
Copy link
Collaborator

tektaxi commented Dec 10, 2020

I think we could use #193 to notify people of changes that are the most relevant to the user. Like "the schedule now works correctly!" or something like that. So along with school things, have Aspine changes listed there.

@psvenk
Copy link
Member Author

psvenk commented Dec 10, 2020

It may also be good to automate some of the version tagging process. @kdk1616 pointed out that there is duplication between the Git tags, GitHub releases, and the changelog. We could have a script which adds a new entry to the changelog (using user-provided input), increments the version number in package.json, runs npm install, commits the changes, tags a new version, and pushes the new commit and tag to GitHub. We could then use something like GitHub Actions for handling releases.

@notrodes
Copy link
Collaborator

We use Github for documenting changes, we link to github from the site already.

@psvenk
Copy link
Member Author

psvenk commented Dec 15, 2020

@notrodes The point of this feature is that most users have an easy way to see what is new in Aspine, in the same vein as the info tab. Most users will probably not want to take the extra step to come to GitHub, especially because the site is billed as a place for software development (not that this is wrong).

@psvenk psvenk removed the on hold Will not be worked on until further notice label Dec 15, 2020
@notrodes notrodes added the bloat notrodes thinks this gets away from why people use aspine label Dec 16, 2020
@notrodes
Copy link
Collaborator

most people know how to click a link and arn't scared to do it

@psvenk psvenk modified the milestones: 2.8.1, 2.7.0 Dec 24, 2020
@psvenk psvenk modified the milestones: 2.6.2, 2.7.0 Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Suspected problem with backend (server or scraper) bloat notrodes thinks this gets away from why people use aspine enhancement New feature or request frontend Suspected problem with frontend (client-side code in public directory)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants