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

[Jupiter] Add version.rb file for jupiter? #55

Closed
murny opened this issue Jul 28, 2017 · 8 comments
Closed

[Jupiter] Add version.rb file for jupiter? #55

murny opened this issue Jul 28, 2017 · 8 comments
Assignees
Labels

Comments

@murny
Copy link
Contributor

murny commented Jul 28, 2017

Nice to have but a version.rb file for jupiter project would be handy. Just like what most ruby gems, these are still really handy in applications as well.

Can use this version to put the version in the html source of our website and other places like on the admins dashboard. This is really helpful for debugging, so you know what version of code is in production.

Also instead of manually cutting tags and pushing them up into github like we are currently doing for hydranorth this should all be done via rake tasks (no different then what a ruby gem has for free)

Simple approach? Copy what a ruby gem has.

Some different examples from big ruby projects:

https://github.com/gitlabhq/gitlabhq/blob/master/lib/gitlab/version_info.rb
https://github.com/discourse/discourse/blob/master/lib/version.rb
https://github.com/diaspora/diaspora/blob/master/config/defaults.yml#L7
https://github.com/tootsuite/mastodon/blob/master/lib/mastodon/version.rb

@mbarnett
Copy link
Contributor

mbarnett commented Apr 9, 2018

Added a VERSION constant in jupiter_core.rb

@weiweishi
Copy link
Contributor

Adding a version.rb file seems to be a simple enough task and will put us on a better track for release tagging/management. It seems that all we need to do is to use one of the version management files from @murny's examples, and add this to application.rb file like so?https://github.com/tootsuite/mastodon/blob/master/config/application.rb#L14

@weiweishi weiweishi reopened this Sep 17, 2018
@murny
Copy link
Contributor Author

murny commented Sep 17, 2018

Yep exactly. That's all you need to do 👍

@weiweishi weiweishi changed the title Add version.rb file for jupiter? [Jupiter] Add version.rb file for jupiter? Oct 19, 2018
@weiweishi
Copy link
Contributor

weiweishi commented Oct 19, 2018

  • Can use example in PMPY for the version.rb file as a constant
  • Embedded into the HTML meta-tag, e.g:
<meta name="generator" content="Jupiter 2.2.0 - https://github.com/ualberta/jupiter">
  • Manage the version through a rake task, to update the version.rb

@weiweishi
Copy link
Contributor

  • move versions from model to version.rb
  • gemcutter gem?
  • find better ways to present the version information?

@weiweishi
Copy link
Contributor

timebox for 1 working day

@murny
Copy link
Contributor Author

murny commented Jan 18, 2019

Work is now done and in master.

Leaving this issue open until we test the release management process of cutting and tagging new versions and add documentation to README.md

@mbarnett
Copy link
Contributor

Pretty sure we can call this done now, yes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants