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

remove need for latest-release-tag, closes #1534 #1541

Closed

Conversation

@lazaridiscom
Copy link
Contributor

lazaridiscom commented Jan 13, 2020

  • fetch the master branch, as commonly done, and as it's described in the official cardano-shelly-testnet docu
    • "By installing Jörmungandr and JCLI from source you can be sure that you get the latest updates of the code." -
  • added section " Further Build Commands" at end with info re specific tag-builds and testing

```sh
git checkout tags/<specific-release-tag> #replace this with something like v1.2.3
git submodule update # always update the submodules after a version change

This comment has been minimized.

Copy link
@rdlrt

rdlrt Jan 13, 2020

This is required even when building off master.

This comment has been minimized.

Copy link
@lazaridiscom

lazaridiscom Jan 13, 2020

Author Contributor

The --recurse-submodules does all the work.

If you mean the 2 lines: please see #1541 (comment)

@@ -49,18 +49,15 @@ If you are on NixOS, use [shell.nix](shell.nix) to pull the dependencies and set

### Commands

Check `<latest release tag>` on https://github.com/input-output-hk/jormungandr/releases/latest
Get the latest "master" branch of the repository and install

This comment has been minimized.

Copy link
@rdlrt

rdlrt Jan 13, 2020

It is not always advisable for end users to run from the master branch, as there could be incompatible changes from previous versions that are unexpected for non-dev (users who are not sure what to make of changelog)

This comment has been minimized.

Copy link
@NicolasDP

NicolasDP Jan 13, 2020

Collaborator

When building from source it is better to checkout a version number, indeed. Otherwise using the master branch for development is better. I prefer to still advise users to use latest master for now (as @rdlrt suggested). It is safer, especially on the long run.

This comment has been minimized.

Copy link
@lazaridiscom

lazaridiscom Jan 13, 2020

Author Contributor

(note that I write "mechanically")

  • Cardano Shelly docu, installs from master => you need to be consistent with this (that's why I changed it)
  • If you want to install latest-stable => remove the need for manual lookup (see #1534)
    • Ensure that Carano Shelly docs get update to use latest-stable, too
  • Developers know anyways what to do
Copy link
Collaborator

NicolasDP left a comment

Thanks for the contribution. I would rather though we change something more along the line of:

# building a version from source

build from \<latest version\>...

# development guides

build from master branch: ...
@@ -49,18 +49,15 @@ If you are on NixOS, use [shell.nix](shell.nix) to pull the dependencies and set

### Commands

Check `<latest release tag>` on https://github.com/input-output-hk/jormungandr/releases/latest
Get the latest "master" branch of the repository and install

This comment has been minimized.

Copy link
@NicolasDP

NicolasDP Jan 13, 2020

Collaborator

When building from source it is better to checkout a version number, indeed. Otherwise using the master branch for development is better. I prefer to still advise users to use latest master for now (as @rdlrt suggested). It is safer, especially on the long run.

@NicolasDP NicolasDP added the doc label Jan 13, 2020
@lazaridiscom

This comment has been minimized.

Copy link
Contributor Author

lazaridiscom commented Jan 13, 2020

Pleases see: #1541 (comment)

At this point, the most important issue is #1534, to allow for automated (or zero-thought) retrieval of latest-stable.

Closing this here, will resend once #1534 is solved.

(As a side-note re processing: Creating simple documentation is an ongoing process, an kind of an art. So, ideally you give the "artist" some freedom, and judge the final result.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.