Added --firefox-changelog-lang

Author: avi12

README.md

@@ -112,6 +112,10 @@ web-ext-deploy --env
   If specified and `firefox.env` exists, it will be used to provide changelog for the Firefox users  
   New lines (`\n`) are supported
 
+- `--firefox-changelog-lang` string?  
+- If specified and `firefox.env` exists, it will be used to dictate the language of the release notes.  
+  Fallbacks to the Manifest's `default_locale` field, if applicable, or `en-US`
+
 - `--firefox-dev-changelog` string?  
   If specified and `firefox.env` exists, it will be used to provide changelog for the Firefox Add-ons reviewers  
   New lines (`\n`) are supported
@@ -269,6 +273,10 @@ web-ext-deploy --chrome-ext-id="ExtensionID" --chrome-refresh-token="RefreshToke
 # A description of the changes in this version, compared to the previous one
 # It's recommended to use instead --firefox-changelog , so it stays up to date
 --firefox-changelog?: string
+
+# The language of the changelog
+# Fallbacks to the Manifest's `default_locale` field, if applicable, or `en-US`
+--firefox-changelog-lang?: string
 
 # A description of the technical changes made in this version, compared to the previous one
 # This will only be seen by the Firefox Addons reviewers
@@ -410,6 +418,10 @@ zipSource?: string;
 # It's recommended to use instead --firefox-changelog , so it stays up to date
 changelog?: string;
 
+# The language of the changelog
+# Fallbacks to the Manifest's `default_locale` field, if applicable, or `en-US`
+changelogLang?: string;
+
 # A description of the technical changes made in this version, compared to the previous one
 # This will only be seen by the Firefox Addons reviewers
 # It's recommended to use instead --firefox-dev-changelog , so it stays up to date
@@ -505,6 +517,7 @@ deployFirefoxSubmissionApi({
   zip: "dist/some-zip-v{version}.zip",
   zipSource: "dist/zip-source-v{version}.zip",
   changelog: "Some changes",
+  changelogLang: "en-US",
   devChangelog: "Changes for reviewers",
   verbose: false
 }).catch(console.error);

src/cli.ts

@@ -30,6 +30,7 @@ const argv = yargs(process.argv.slice(2))
     firefoxZip: { type: "string" },
     firefoxZipSource: { type: "string" },
     firefoxChangelog: { type: "string" },
+    firefoxChangelogLang: { default: "en-US" },
     firefoxDevChangelog: { type: "string" },
     // edge
     edgeClientId: { type: "string" },

src/index.ts

@@ -19,6 +19,7 @@ const argv = yargs(process.argv.slice(2))
     publishOnly: { type: "array", default: [] },
     getCookies: { type: "array" },
     firefoxChangelog: { type: "string" },
+    firefoxChangelogLang: { default: "en-US" },
     firefoxDevChangelog: { type: "string" },
     edgeDevChangelog: { type: "string" },
     operaChangelog: { type: "string" },

src/stores/firefox/firefox-deploy.ts

@@ -70,13 +70,17 @@ async function handleRequestWithBackOff<T>({
       }
 
       // Some sort of client error
+      let errorMessage = getErrorMessage({
+        store: STORE,
+        error: JSON.stringify(e.response.data),
+        actionName: errorActionOnFailure,
+        zip
+      });
+      if (errorMessage.match(/release_notes.+The language code.+is invalid/)) {
+        errorMessage += " Supported language codes: https://github.com/mozilla/addons-server/blob/master/src/olympia/core/languages.py";
+      }
       return [
-        getErrorMessage({
-          store: STORE,
-          error: JSON.stringify(e.response.data),
-          actionName: errorActionOnFailure,
-          zip
-        })
+        errorMessage
       ];
     }
   }
@@ -106,7 +110,7 @@ async function uploadZip({
   formData.append("channel", "listed");
 
   const sendRequest = () =>
-    axios.post<FirefoxUploadDetail>(`upload/`, formData, {
+    axios.post<FirefoxUploadDetail>("upload/", formData, {
       headers: {
         "Content-Type": "multipart/form-data"
       }
@@ -128,25 +132,27 @@ async function createNewVersion({
   slug,
   uuid,
   changelog,
+  changelogLang,
   devChangelog,
   isVerbose,
   zip
 }: {
   slug: string;
   uuid: string;
   changelog: string;
+  changelogLang: string;
   devChangelog: string;
   isVerbose: boolean;
   zip: string;
 }): Promise<[undefined, FirefoxCreateNewVersion] | [string]> {
   // https://addons-server.readthedocs.io/en/latest/topics/api/addons.html#version-create
-  const { default_locale = "en-US" } = getExtJson(zip);
+  const { default_locale = changelogLang } = getExtJson(zip);
   const sendRequest = async () =>
     axios.post(`addon/${slug}/versions/`, {
       upload: uuid,
       ...(changelog && {
         release_notes: {
-          [default_locale]: changelog
+          [default_locale.replaceAll("_", "-")]: changelog
         }
       }),
       ...(devChangelog && {
@@ -266,6 +272,7 @@ export default async function deployToFirefox({
   zip,
   zipSource = "",
   changelog = "",
+  changelogLang = "en-US",
   devChangelog = "",
   verbose: isVerbose
 }: FirefoxOptionsSubmissionApi): Promise<boolean> {
@@ -320,6 +327,7 @@ export default async function deployToFirefox({
     slug: extId,
     uuid,
     changelog,
+    changelogLang,
     devChangelog,
     isVerbose,
     zip

src/stores/firefox/firefox-input.ts

@@ -30,6 +30,12 @@ export class FirefoxOptionsSubmissionApi {
    */
   changelog?: string;
 
+  /**
+   * The language of the changelog, e.g. `en-US`<br>
+   * Fallback: `manifest.default_locale` or `en-US`
+   */
+  changelogLang = "en-US";
+
   /**
    * A description of the technical changes made in this version, compared to the previous one<br>
    * This will only be seen by the Firefox Addons reviewers<br>