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

feat: add the ability to show a release candidate as pre-release in the UI #278

Merged
merged 3 commits into from
Jun 17, 2021

Conversation

aayushmau5
Copy link
Member

Description

  • This PR will mark a release candidate/pre-release as pre-release for next version, with release date

Screeshots
Screenshot_2021-06-16_14 50 55
Screenshot_2021-06-16_14 51 09

Related issue(s)
#86

@netlify
Copy link

netlify bot commented Jun 16, 2021

✔️ Deploy Preview for asyncapi-website ready!

🔨 Explore the source changes: eaea13b

🔍 Inspect the deploy log: https://app.netlify.com/sites/asyncapi-website/deploys/60cafe0d8922950008edc8d1

😎 Browse the preview: https://deploy-preview-278--asyncapi-website.netlify.app

@aayushmau5 aayushmau5 changed the title feat: add the ability to show a release as pre-release feat: add the ability to show a release candidate as pre-release Jun 16, 2021
@aayushmau5 aayushmau5 changed the title feat: add the ability to show a release candidate as pre-release feat: add the ability to show a release candidate as pre-release in the UI Jun 16, 2021
Comment on lines 64 to 68
if(fileName.includes('release')) {
details.isPrerelease = true
details.releaseDate = getReleaseDate(fileName)
fileName = fileName.split('-')[0]
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Some assumptions have been made here by me.

  1. The rc will always have release in the filename.
  2. The format for the filename will always be <release-version>-<year>-<month>-<release>.md. ex. v2.1.0-2021-06-release.md.
    This is being used in marking a rc as pre-release as well as getting the release date.

Copy link
Member

Choose a reason for hiding this comment

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

good assumptions, and valid ones, you can put them as a comment for future generations and even refer asyncapi/spec#513 (comment) in the comment for future generations

scripts/build-post-list.js Outdated Show resolved Hide resolved
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

last general comment: I have consistency-related doubts regarding the stripping of the v from the version for the title. It feels weird that in docs it will be without v and then the tag and also link will contact v 🤔

@aayushmau5
Copy link
Member Author

🤔 Do we add the v back? It won't really affect the URL and such.

@derberg
Copy link
Member

derberg commented Jun 16, 2021

@aayushmau5 I'm honestly not sure, there are pros and cons for both. So maybe just leave it as it is, v is technical and without v is what user should anyway use in asyncapi: 2.0.0 field

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

ping me when you are ready for another review round

@aayushmau5
Copy link
Member Author

@derberg Made some changes. Please review :)

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

awesome stuff, I guess we are ready on the website side now and can work on merging the action in spec repo right?

@aayushmau5
Copy link
Member Author

aayushmau5 commented Jun 17, 2021

Yeah, I think so. Everything done on the website side. Made some changes on the Actions. Just need to verify it, and then, we can merge it.

@derberg derberg merged commit 74b741c into asyncapi:master Jun 17, 2021
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