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

Adopt Shell Scripts from StdLib Repository #81

Open
tajmone opened this issue Oct 12, 2020 · 0 comments
Open

Adopt Shell Scripts from StdLib Repository #81

tajmone opened this issue Oct 12, 2020 · 0 comments
Labels
💡 enhancement A new feature or enhancement request/proposal 🕑 pending implementation Approved changes waiting to be implemented ⭐ automation Topic: Project automation and/or repo CI ⚠️ needed Priority: Medium

Comments

@tajmone
Copy link
Collaborator

tajmone commented Oct 12, 2020

In the AlanStdLib repository I'm developing a rather powerful set of Bash functions to handle the various toolchains efficiently — see the assets/sh/ folder on StdLib repo.

These scripts assets enforce a working environment that is initialized at each script execution, providing global functions and variables that simplify some common operation that are fairly complex — e.g. converting ALAN related files to UTF-8 for Asciidoctor inclusion, and sanitize them by formatting transcript logs to AsciiDoc, and removing region tag comments line in the ALAN sources that are deployed to end users (e.g. the tutorial files from the ALAN Beginner's Guide). The also provide some helper functions for common Bash operations, like translating relative paths to absolute paths, or converting Bash paths to Windows paths, which are both required when dealing with some third party dependencies that require path parameters (some apps don't work well under Bash for Windows, hence the need for paths fixes).

Switching all scripts to .sh will eliminate the current scripts redundancy (Bash and Batch) and provide a better cross-platform toolchain, especially where CI operations are involved.

Currently those scripts are still bound to the StdLib repository, but I'm gradually working on making them project-agnostic, and will possible move them to a dedicated repository so that they can be included as a Git module in any ALAN project that needs them, thus centralizing their maintenance and simplifying toolchains updates across the various ALAN repositories.

When the scripts will be ready, I'd like to integrate them in the Alan-Docs repository, and replace all the current scripts with the new Bash toolchain, which will provide a more efficient and consistent way of handling the various documents. It will take some time though, so in the meantime we'll have to keep using the current Shell/Batch scripts.

@tajmone tajmone added 💡 enhancement A new feature or enhancement request/proposal 🕑 pending implementation Approved changes waiting to be implemented ⚠️ needed Priority: Medium ⭐ automation Topic: Project automation and/or repo CI labels Oct 12, 2020
@tajmone tajmone added this to the Toolchain Improvements milestone Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 enhancement A new feature or enhancement request/proposal 🕑 pending implementation Approved changes waiting to be implemented ⭐ automation Topic: Project automation and/or repo CI ⚠️ needed Priority: Medium
Projects
None yet
Development

No branches or pull requests

1 participant