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 compiled setup scripts from Git, use CI instead #462

Open
mks-h opened this issue Sep 5, 2024 · 10 comments · Fixed by #520
Open

Remove compiled setup scripts from Git, use CI instead #462

mks-h opened this issue Sep 5, 2024 · 10 comments · Fixed by #520
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@mks-h
Copy link
Member

mks-h commented Sep 5, 2024

Having both the source Amber files and the generated Bash files checked out in Git leads to inconsistency. For example see PR #457, which updates generated Bash files, as they were outdated.

Instead, lets set up a CI pipeline which will publish the generated Bash scripts at each release, and reference them in the installation instructions.

@Mte90
Copy link
Member

Mte90 commented Sep 5, 2024

From the issue title do you mean that these amber scripts should be CI updated?

I agree but I think that we just need to recompile them at every new release inside the repository.

@Mte90 Mte90 added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 5, 2024
@KrosFire
Copy link
Member

KrosFire commented Sep 5, 2024

Committing obscure script that installs the software without approves is sus ngl ;)

We should compile add only via CI or/and check them in CI if they yield the same result

@mks-h
Copy link
Member Author

mks-h commented Sep 5, 2024

@Mte90, I don't see a point in keeping compiled scripts in the repo. That can only lead to problems.

@Ph0enixKM
Copy link
Member

Ph0enixKM commented Sep 5, 2024

I'm all in. This issue should have "sub issues" to update the install snippet on the website and documentation

@Mte90
Copy link
Member

Mte90 commented Sep 6, 2024

@Mte90, I don't see a point in keeping compiled scripts in the repo. That can only lead to problems.

The install/uninstall scripts can't be in Amber, otherwise users how can they use them?

@mks-h
Copy link
Member Author

mks-h commented Sep 6, 2024

Again, the idea is that the CI will compile Amber to Bash, and include it into the release.

@Mte90
Copy link
Member

Mte90 commented Sep 6, 2024

So the Bash script will be in the release page? I am asking for this because usually that file is placed in the repository itself.
Also it isn't updated so much often but we did some improvements in the last release.

@mks-h
Copy link
Member Author

mks-h commented Sep 6, 2024

Yes, it will be in the releases. Placing it in the repo itself may make total sense for other projects, but only because they write it in Bash by hand. Our Bash scripts are just an artifact from the Amber files that are in the repo.

@Mte90
Copy link
Member

Mte90 commented Sep 9, 2024

It is a pattern that I never saw honestly, could make sense but in the past we updated the installer also without doing a new release.

@Mte90
Copy link
Member

Mte90 commented Oct 22, 2024

We have the CI but we will remove the files from the repo at the next release so we can update the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants