Skip to content

Latest commit

 

History

History
75 lines (62 loc) · 3.33 KB

readme.md

File metadata and controls

75 lines (62 loc) · 3.33 KB
Raw

mrconfig

(manage repo configuration) mrconfig

Used to manage translation updates for NVDA and NVDA add-ons.

Add-on store and website

For information on having add-ons added to the NVDA add-on store and legacy nvda-addons website: https://github.com/nvaccess/addon-datastore/blob/master/docs/submitters/submissionGuide.md

Translating your addon

Steps for addon authors

  1. The add-on repo must contain a branch named stable. The translation system uses the stable branch to sending/receiving translation updates to/from NVDA translation repo.
  2. Ask for the add-on to be included in the translation system via the NVDA add-ons mailing list.
    • A member of the NVDA add-on team creates a repo for the add-on at NVDA Addons GitHub
    • The member of the NVDA add-on team should confirm there is a branch stable
    • nvaccessAuto should have permission to push to the stable branch.
  3. Create an issue on nvaccess/mrconfig asking for the addon to be included.
    • NV Access staff will update the server:
      • cd mr
      • mr up
      • cd available.d
      • mr registerAddon addonRepoName Ensure that addonRepoName matches repo_name in buildVars. See commonIssues 'po file missing'.
      • git push
      • cd ../ (mr dir)
      • mr up
      • cd addons/<addonRepoName>
      • git checkout stable (if there is an error, see docs/commonIssues.md)
      • mr addon2settings
      • cd ../../srt
      • svn commit */settings -m "Make <addonName> add-on available for translation."
    • NV Access staff will edit mr/automatic.crontab
      • Copy one of the lines for one of the existing addons, just change the addon name and paste it in the correct section, commit and push.
      • Note: Run line from crontab manually to confirm.
      • Commit and push changes to master

Maintaining the add-on

Note: Maintainers may follow other procedures. This info is provided for convenience, according to discussions like this topic about repos management.

  • Clone the maintainer repo:
    • git clone https://github.com/githubUserName/addonRepoName
  • Add remote for GitHub/nvdaaddons repo:
    • git remote add nvdaaddons https://github.com/nvdaaddons/addonRepoName
  • Fetch the GitHub/nvdaaddons repo:
    • git fetch nvdaaddons
  • Track the stable branch:
    • git checkout -t nvdaaddons/stable
  • Periodically:
    • From stable branch:
      • git pull # Get translations
      • git merge master # Stable code containing translatable messages
      • git push nvdaaddons stable
    • From master:
      • git pull
      • git merge stable
      • git push origin master # Update translations

References for maintainers

Related links