Provide more short way to install dotenv-linter #220

DDtKey · 2020-06-23T18:45:53Z

Implemented a script for more short way to install dotenv-linter (#112).

The advantage of the solution is its cross-platform.
The script is executed with curl/wget and even under Windows (checked on MINGW).

Complexity is the process of automatically declaring an environment variable. In some cases, this is only possible manually at the moment.

This is a working version, I also tested on Alpine Linux.

But I would like to hear any ideas for improving or changing the approach.

Perhaps when we come to a final decision, it makes sense to create a separate repository.
Although for installing binaries with a script, it looks suitable in this repo, so far it is not more than 1 file.

✔ Checklist:

This PR has been added to CHANGELOG.md (at the top of the list);
Docs have been added / updated (for bug fixes / features).

DDtKey · 2020-06-23T21:21:29Z

One option is to install dotenv-linter at the system level(/opt/dotenv-linter for example) and create a symlink in /usr/local/bin.
This will work without any export of variables at different shell levels.

But it will require the user rights to sudo. It will be more difficult for users to override the version only for themselves, and, unfortunately, such a scenario will have many exceptions for Windows 🤔

mstruebing · 2020-06-24T08:23:34Z

Very nice work, thank you, unfortunately I'm a bit low on time right now. But I will have a detailed look soonish, at latest this weekend. 🚀

mgrachev · 2020-06-24T11:30:17Z

@DDtKey That's awesome! Thank you! 🔥

DDtKey · 2020-06-30T08:07:56Z

@dotenv-linter/maintainers glad to hear any comments and discuss this

install.sh

README.md

install.sh

mgrachev · 2020-06-30T17:55:51Z

@DDtKey I've left some comments. Please, look at them.

Also, please look at this example of installing via a script: https://github.com/reviewdog/reviewdog#installation.
I like that API. Can we have something like that? 🙂

mgrachev · 2020-06-30T19:55:16Z

Also, it would be nice if we could test this script via GitHub Actions on Linux, Mac and Windows.
What do you think about it?

DDtKey · 2020-07-02T16:25:18Z

Also, it would be nice if we could test this script via GitHub Actions on Linux, Mac and Windows.
What do you think about it?

Good idea, but until release 2.1.0 we cannot run a script test for Windows, because there are no published versions.
He will fall.
We can certainly expect this now, and after the release update test behavior 🤔

mgrachev · 2020-07-02T18:51:29Z

Good idea, but until release 2.1.0 we cannot run a script test for Windows, because there are no published versions.
He will fall.
We can certainly expect this now, and after the release update test behavior 🤔

Agree. In the first iteration we can add tests only for Mac and Linux.

# Conflicts: # CHANGELOG.md

DDtKey · 2020-07-03T19:21:23Z

Also, it would be nice if we could test this script via GitHub Actions on Linux, Mac and Windows.
What do you think about it?

I made the changes we talked about, also added CI tests

.github/workflows/ci.yml

README.md

docs/install.md

README.md

docs/install.md

install.sh

mgrachev · 2020-07-07T11:23:05Z

@mstruebing What do you think about it?

# Conflicts: # CHANGELOG.md

codecov-commenter · 2020-07-08T12:49:23Z

Codecov Report

Merging #220 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #220   +/-   ##
=======================================
  Coverage   97.10%   97.10%           
=======================================
  Files          16       16           
  Lines        1485     1485           
=======================================
  Hits         1442     1442           
  Misses         43       43

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 34ffdf7...20e9ca0. Read the comment docs.

DDtKey · 2020-07-08T13:00:49Z

I just resolved the conflict in CHANGELOG.md (merge master to current branch).

But faced with an unpleasant feature, when we use api github, it has limitations on the number of calls.

We need this to get the "latest" version.
I think this is not a problem in general, but CI starts quite often and this time it ran into a limit, which could happen again.

I see three possible solutions:

In CI tests use a specific version to test the script (but we do not test to get the latest version unfortunately)
As it was before: do not display the latest version number (i.e., use a static link to access the github, bypassing the api).
Modify the script, for example, in case of an error in obtaining the version in api, download the latest version directly, bypassing the api

What do you think?
@dotenv-linter/core

install.sh

mstruebing · 2020-07-08T13:28:26Z

In CI tests use a specific version to test the script (but we do not test to get the latest version unfortunately)

In tests we could use https://github.com/dotenv-linter/dotenv-linter/releases/latest/download/dotenv-linter-os-arch.gz to always have the newest version

Why do we need to print the version number on install anyway? Wouldn't it be enough to say after installation finishes we present the user the version (by using dotenv-linter --version)?

DDtKey · 2020-07-08T13:39:01Z

In CI tests use a specific version to test the script (but we do not test to get the latest version unfortunately)

In tests we could use https://github.com/dotenv-linter/dotenv-linter/releases/latest/download/dotenv-linter-os-arch.gz to always have the newest version

Why do we need to print the version number on install anyway? Wouldn't it be enough to say after installation finishes we present the user the version (by using dotenv-linter --version)?

This approach was used before discussing the print of the installed version

But in fact, I agree, this option will solve the problems of limiting api github and reduce the number of calls to curl / wget 🤔
What do you think? @mgrachev

mgrachev · 2020-07-08T13:40:26Z

Why do we need to print the version number on install anyway? Wouldn't it be enough to say after installation finishes we present the user the version (by using dotenv-linter --version)?

I like this idea 👍

mstruebing · 2020-07-08T13:44:35Z

This approach was used before discussing the print of the installed version

Sorry, I didn't followed the conversation :)

DDtKey · 2020-07-08T14:23:23Z

@dotenv-linter/core thanks for feedback 👏
I returned using the latest version static URL to minimize API calls. User can always use dotenv-linter -v

install.sh

mgrachev · 2020-07-08T14:40:47Z

I returned using the latest version static URL to minimize API calls. User can always use dotenv-linter -v

I thought that @mstruebing suggested getting the version of dotenv-linter using the dotenv-linter -v command and printing it after installation is completed. Or am I misunderstood?

DDtKey · 2020-07-08T14:43:40Z

I returned using the latest version static URL to minimize API calls. User can always use dotenv-linter -v

I thought that @mstruebing suggested getting the version of dotenv-linter using the dotenv-linter -v command and printing it after installation is completed. Or am I misunderstood?

This is my misunderstanding, I apologize, it option really impresses me. Thank you 👍

DDtKey added 3 commits June 23, 2020 20:21

Create install.sh for provide more short way to install

6a7d243

Update README.md and fix install.sh

903ec60

Update CHANGELOG.md

f302115

DDtKey requested review from mgrachev and mstruebing June 23, 2020 18:48

DDtKey linked an issue Jun 23, 2020 that may be closed by this pull request

Provide more short way to install dotenv-linter #112

Closed

DDtKey added 3 commits June 25, 2020 14:18

Merge branch 'master' into install-sh

7d57769

Merge branch 'master' into install-sh

d71dcd8

Merge branch 'master' into install-sh

d1efb7b

Merge branch 'master' into install-sh

5f98a35

mgrachev reviewed Jun 30, 2020

View reviewed changes

DDtKey added 5 commits July 3, 2020 18:31

Merge branch 'master' into install-sh

8282401

# Conflicts: # CHANGELOG.md

Change installation API

dd555df

Update docs

ad3cca5

Add CI checks

04a78d1

Run locally install.sh

1018dac

DDtKey requested a review from mgrachev July 3, 2020 19:21

mgrachev reviewed Jul 4, 2020

View reviewed changes

Print latest version and small improvements

2c487cc

DDtKey requested a review from mgrachev July 4, 2020 10:58

mgrachev previously approved these changes Jul 4, 2020

View reviewed changes

mgrachev mentioned this pull request Jul 4, 2020

Release v2.1.0 #217

Closed

5 tasks

DDtKey added this to the v2.1.0 milestone Jul 6, 2020

Merge branch 'master' into install-sh

20e9ca0

# Conflicts: # CHANGELOG.md

DDtKey dismissed mgrachev’s stale review via 20e9ca0 July 8, 2020 12:48

mstruebing reviewed Jul 8, 2020

View reviewed changes

install.sh Outdated Show resolved Hide resolved

Revert printing latest version for minimize GitHub API calls

2e16cd7

DDtKey requested review from mgrachev and mstruebing July 8, 2020 14:26

mgrachev reviewed Jul 8, 2020

View reviewed changes

install.sh Outdated Show resolved Hide resolved

Print installed version after install dotenv-linter

3a81c23

DDtKey requested a review from mgrachev July 8, 2020 14:44

mgrachev approved these changes Jul 8, 2020

View reviewed changes

mstruebing approved these changes Jul 8, 2020

View reviewed changes

DDtKey merged commit 935aa01 into dotenv-linter:master Jul 8, 2020

DDtKey mentioned this pull request Jul 8, 2020

Add CI installation tests for Windows #235

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide more short way to install dotenv-linter #220

Provide more short way to install dotenv-linter #220

DDtKey commented Jun 23, 2020 •

edited

DDtKey commented Jun 23, 2020 •

edited

mstruebing commented Jun 24, 2020

mgrachev commented Jun 24, 2020

DDtKey commented Jun 30, 2020

mgrachev commented Jun 30, 2020

mgrachev commented Jun 30, 2020

DDtKey commented Jul 2, 2020 •

edited

mgrachev commented Jul 2, 2020

DDtKey commented Jul 3, 2020

mgrachev commented Jul 7, 2020

codecov-commenter commented Jul 8, 2020

DDtKey commented Jul 8, 2020 •

edited

mstruebing commented Jul 8, 2020 •

edited

DDtKey commented Jul 8, 2020

mgrachev commented Jul 8, 2020

mstruebing commented Jul 8, 2020

DDtKey commented Jul 8, 2020 •

edited

mgrachev commented Jul 8, 2020 •

edited

DDtKey commented Jul 8, 2020

Provide more short way to install dotenv-linter #220

Provide more short way to install dotenv-linter #220

Conversation

DDtKey commented Jun 23, 2020 • edited

✔ Checklist:

DDtKey commented Jun 23, 2020 • edited

mstruebing commented Jun 24, 2020

mgrachev commented Jun 24, 2020

DDtKey commented Jun 30, 2020

mgrachev commented Jun 30, 2020

mgrachev commented Jun 30, 2020

DDtKey commented Jul 2, 2020 • edited

mgrachev commented Jul 2, 2020

DDtKey commented Jul 3, 2020

mgrachev commented Jul 7, 2020

codecov-commenter commented Jul 8, 2020

Codecov Report

DDtKey commented Jul 8, 2020 • edited

mstruebing commented Jul 8, 2020 • edited

DDtKey commented Jul 8, 2020

mgrachev commented Jul 8, 2020

mstruebing commented Jul 8, 2020

DDtKey commented Jul 8, 2020 • edited

mgrachev commented Jul 8, 2020 • edited

DDtKey commented Jul 8, 2020

DDtKey commented Jun 23, 2020 •

edited

DDtKey commented Jun 23, 2020 •

edited

DDtKey commented Jul 2, 2020 •

edited

DDtKey commented Jul 8, 2020 •

edited

mstruebing commented Jul 8, 2020 •

edited

DDtKey commented Jul 8, 2020 •

edited

mgrachev commented Jul 8, 2020 •

edited