V1 for Automation Website translations Issues Generation Ref: Issue 325

[sergioarmgpl]

Hi Dear TAG Env Team, this is the final the work that we are doing with @Dianmz.

This includes a workflow called Check outdated content, that generates new Issues for Languages for ES & ZH languages at the moment. Currently the issues are assigned to Diana and I, but should be modified to the new groups that you suggested or new ones.

The issues will look like this:

And inside the issue will look like this:

cc: @leonardpahlke @guidemetothemoon

[netlify]

✅ Deploy Preview for tag-env-sustainability ready!

Name	Link
🔨 Latest commit	26b422a
🔍 Latest deploy log	https://app.netlify.com/sites/tag-env-sustainability/deploys/6631cea29d8e6c000828172c
😎 Deploy Preview	https://deploy-preview-407--tag-env-sustainability.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[leonardpahlke]

Thank you so much! I added a couple of comments.

cc @nate-double-u you may be interested in this work too. It about automatically detecting if translations to the TAG website need to happen & opens issues for translators to do translations.

[leonardpahlke]

Thanks for all the work! Awesome that it works! Three comments from my side:

1. We need documentation
2. We may need to revise some parts of the script

Documentation

Could we add some documentation about this. We do not have any development guide for the website so lets create a new document WEBSITE_DEVELOPMENT.md which has a section about how we do translations. The document can be extended with additional content (website dev related stuff).

About the translations, it would be good to explain:

1. How does it work / What happens if you make a change to the english version of the website
2. maintenance steps
   2.1. Adding a new translation. (for example, French - which steps do we need to take to support translations)
   2.2. Which people are notified to facilitate translations and how to edit this information
3. Explain what happens if the workflow is not followed; like:
   3.1. Changes are made to the Spanish side initially (our workflow does not work, right - this is ok! But it would be good to write a sentence about that)
   3.2. The Translation issue is closed, and no translation was made. In this case, the translation will stay out of sync, right. (this is fine too 😄 - but would be good to document it)
   3.3. ...
4. How to work with the pipeline - how to test it if you make edits (step 1, step 2)

Adding this would be fantastic! (feel free to add to this if you feel it is relevant information)

Script / Code

For my taste, the script is too long to be inline. It's not just a few commands which we can understand quickly, it's a bit more complicated; so we need to move it. We can stick to shell scripts.

example:

    - name: Run script file
      run: |
         chmod +x ./public/scripts/test.sh
         ./public/scripts/test.sh
      shell: bash

After these changes were made, I will have a closer look at the logic. I added a few more comments to the code already.

🙌

[sergioarmgpl]

Thanks true, I will add this to the contributors document.

[leonardpahlke]

The comment says "remove later". It would be good to keep this logging functionality and enable these logs over a --debug flag.

Example code by an LLM (needs to be tested)

# Default debug level
DEBUG_LEVEL="info"

# Parse command-line options
while [[ "$1" != "" ]]; do
    case $1 in
        --debug)
            DEBUG_LEVEL="debug"
            ;;
        *)
            # Unknown option
            echo "Unknown option: $1"
            exit 1
            ;;
    esac
    shift
done

# Log function
_log() {
    local message="$1"
    local level="$2"

    # Determine if the message should be logged based on DEBUG_LEVEL
    case "$DEBUG_LEVEL" in
        debug)
            # Log all messages
            echo "$level: $message"
            ;;
        info)
            # Log only info and error messages
            if [[ "$level" == "info" || "$level" == "error" ]]; then
                echo "$level: $message"
            fi
            ;;
        error)
            # Log only error messages
            if [[ "$level" == "error" ]]; then
                echo "$level: $message"
            fi
            ;;
    esac
}

# Example usage:
_log "This is an info message" "info"
_log "This is a debug message" "debug"
_log "This is an error message" "error"

[leonardpahlke]

Also, it would be spectacular if there is an --dry-run option. So we can see which issues would be opened without opening any. (but we dont need to add this - would be great tho 😄, very helpful debugging, i suppose). Example execution: translation.sh <ORG> <REPO> <PR NUMBER> --dry-run --debug

[sergioarmgpl]

Yes, We were thinking about to have a script instead of put this in the pipeline, is a good idea.

[leonardpahlke]

I am wondering how we make sure that we have minimal maintenance, adding new translations in the future. We could for example look at the repository and check the folder names https://github.com/cncf/tag-env-sustainability/tree/main/website/content - we have a folder en & zh & es &de, we establish a base with en (we dont need to open a PR for en since its already merged). This could eliminate referencing languages in the script.

Assigning people over groups could work this way too. We assign tag-env-translators-<LANGUAGE REFERENCE> so for example tag-env-translators-es.

[sergioarmgpl]

Yes, we could work on it.

[leonardpahlke]

Do you mind explaining this code? We create a txt file per translation language. So we end up with zh.txt, es.txt ... why do we need these files? Probably we add this info to the issue descriptions, right.

[sergioarmgpl]

Sure we have to document that part.

[leonardpahlke]

This part makes me think if we may want to move the logic to smth like Go or Python, which handles more complex logic better IMO. Thoughts?

[sergioarmgpl]

I think that it could be less lines with bash, but let me document the script.

[thelooter]

It looks like there was some commit mess-up, since there are some commits in here, that are already in master