Mapeo Support Materials
Español
Español
  • Introducción
  • Visión general
    • Acerca de Mapeo
      • Herramientas de Mapeo
      • Base de datos de pares y sincronización de Mapeo
      • ¿Cómo se está usando Mapeo?
    • ¿Mapeo es adecuado para mí?
    • FAQs
  • Guía de inicio rápido
    • Empezando...
    • Mapeo Mobile
    • Mapeo Desktop
  • Guía de referencia completa
    • Bienvenid@ – Introducción
    • 🗒️Elementos esenciales para un proyecto de Mapeo exitoso
      • Planeando un proyecto de Mapeo
        • Cuál es el objetivo del proyecto?
        • Qué resultados (productos/materiales) quieres?
        • Qué información recolectar?
          • Tipos de datos dentro de Mapeo
        • Quién debe participar y cómo?
        • Cuáles son los parámetros?
      • Evaluación de riesgos y seguridad
      • Creando protocolos de usuario
    • ✔️Mapeo funcionará de inmediato para mí?
      • Configuración por defecto
      • Mapa de fondo por defecto
    • ⚙️Opciones de personalización
      • Traducir Mapeo y configuraciones predeterminadas
      • Configuraciones personalizadas
        • Creando configuraciones personalizadas
          • Planeando la configuración y la estructura de datos
            • Categorías
            • Iconos
            • Campos de detalles
          • Codificar la configuración
            • Adding icon files
              • Crear y exportar archivos SVG usando Adobe Illustrator
              • Crear y exportar archivos SVG usando Inkscape
            • Creating details fields
            • Creating categories
            • Defining geometry defaults
            • Adding a project key
            • Adding project name and version
            • Building configuration file
              • Via the command line
              • Using GitHub Actions
          • Probando e iterando
      • Mapas de fondo personalizados
        • Creando mapas de fondo personalizados
    • 📱Mapeo Mobile: instalación y ajustes
      • Instalar Mapeo Mobile
      • Elegir los ajustes de Mapeo Mobile
      • Importar configuraciones a Mapeo Mobile
      • Añadir mapas de fondo personalizados a Mapeo Mobile
      • Actualizar Mapeo Mobile
    • 📱Mapeo Mobile: uso
      • Activar el GPS y ver la posición actual
      • Crear observaciones
      • Ver observaciones
      • Editar y borrar observaciones
      • Compartir datos externamente
      • Sincronizar datos a través Wi-Fi
    • 💻Mapeo Desktop: instalación y ajustes
      • Instalar Mapeo Desktop
      • Escoger el idioma de Mapeo Desktop
      • Importar configuraciones a Mapeo Desktop
      • Añadir mapas de fondo personalizados a Mapeo Desktop
      • Actualizar Mapeo Desktop
    • 💻Mapeo Desktop: uso
      • Mapeo Desktop para gestionar datos de Mapeo Mobile (modo Observaciones)
        • Sincronizar datos
          • Sincronizar a través de Wi-Fi
          • Sincronizar con un archivo
        • Ver observaciones
        • Editar y borrar observaciones
        • Exportar datos y compartir externamente
      • Mapeo Desktop para la creación de datos territoriales (modo Territorio)
        • Navegar por el mapa
        • Crear y editar datos territoriales
        • Cambiar mapas de fondo en el modo Territorio
        • Importar y usar datos geoespaciales externos
        • Exportar y sincronizar datos
      • Sincronizar datos con Mapeo Desktop
    • 💡Capacitaciones en Mapeo
      • Definir objetivos y formato
      • Estructurar una capacitación
        • Buenas prácticas para planificar una capacitación
        • Estructuración de la agenda, contenidos y actividades
          • Sugerencias para las diferentes secciones de un evento de capacitación
          • Consejos y actividades sugeridas para capacitar en las funciones clave de Mapeo
          • Materiales y recursos disponibles para el evento de capacitación
      • Preparación de equipos y suministros para una capacitación
        • Equipos y suministros recomendados
        • Preparación técnica antes de realizar la formación presencial
    • 🔧Solución de problemas
      • No puedo iniciar Mapeo
      • Mapeo se cierra automáticamente
      • Tengo problemas con el GPS en Mapeo
        • No se activa el GPS en Mapeo
        • Mi señal de GPS es muy débil
      • Tengo problemas con la cámara en Mapeo
        • Me aparece una pantalla negra cuando uso la cámara
      • Quiero actualizar los permisos de Mapeo Mobile
      • Tengo problemas de sincronización
        • Quiero conectarme a una red Wi-Fi
        • Quiero crear redes Wi-Fi locales
          • Con un router portátil
          • Con un celular
        • El dispositivo con el que quiero sincronizar no aparece en mi pantalla Sincronizar
        • Me aparece un error cuando intento sincronizar con otro dispositivo
        • No puedo sincronizar con el archivo de sincronización
        • La persona con la que quiero sincronizar ha eliminado datos valiosos
      • Quiero compartir archivos entre dispositivos
      • Quiero guardar e imprimir materiales de referencia de Mapeo
    • Glosario y hojas de referencia rápida
      • Glosario de términos relacionados con Mapeo
      • Descripción general de la pantalla del modo Territorio de Mapeo Desktop
  • Para desarrolladores
    • La arquitectura de Mapeo
    • Repositorios de Mapeo
  • Apoyo
  • Referencias adicionales
  • Digital Democracy website
Powered by GitBook
On this page
  • Setting up a configuration repository on GitHub
  • Getting ready to build
  • How it works
  • Use conventional commit messages to increment your configuration version
  • Compile a final, versioned release of your configuration
Export as PDF
  1. Guía de referencia completa
  2. Opciones de personalización
  3. Configuraciones personalizadas
  4. Creando configuraciones personalizadas
  5. Codificar la configuración
  6. Building configuration file

Using GitHub Actions

PreviousVia the command lineNextProbando e iterando

Last updated 3 years ago

It is possible to build a Mapeo configuration file using GitHub Actions. This requires setting up your custom configuration directory as a repository on , adding a /.github/workflows/build.yml script to your repository, and committing changes to that repository.

If you haven't already used GitHub, you may want to study the of how GitHub works before proceeding.

Note that since this process relies on using github.com, that you will need internet access to run the build action and download the .mapeosettings configuration file. Hence, unlike building a configuration Via the command line, this process will not work in an offline context.

Setting up a configuration repository on GitHub

The first step will be to set up your configuration as a repository on github.com, with the requisite build script files that will trigger a GitHub Actions Workflow to generate your .mapeosettings file. There are a few ways to do this.

If you do not have your own custom configuration already, and are starting from scratch:

  1. You can fork or upload either the or the template to your own GitHub account. The choice you make will depend on how you will go about creating your own configuration, as detailed in Planeando la configuración y la estructura de datos.

  2. Make sure that you have the .github/workflows directory in your configuration repository.

If you already have your own custom configuration:

  1. Create a repository on GitHub for your custom configuration.

  2. Commit your existing configuration content to the repository.

  3. Download either the or the , and copy over the .github directory to the root directory of your custom configuration.

  4. Commit these files to your repository on Github.com. (Github may ask you for additional permissions to add these files, by confirming via the browser.)

NOTE: Depending on your operating system and setup, it is possible that you do not see a .github/ directory anywhere. You may need to enable viewing hidden files in your system file manager. On MacOS, you can do so by pressing Command + Shift + . (period) in your Finder window.

Getting ready to build

Navigate to the Actions screen, and Click "I understand my workflows, go ahead and enable them."

This will bring you to a view of your Workflows. You should see a message "There are no workflow runs yet" if you just enabled Workflows for the first time. You are now ready to start building .mapeoconfig files.

How it works

Once you have enabled Action Workflows on your configuration repository, GitHub will generate a Workflow to build a new version of your configuration every single time that you commit a change to your repository.

Once you have committed a change to your repository, and navigate to the Actions tab, you should see your commit message listed as a workflow.

You can click on your commit message to find out more about the status of your build. For example, if your build has encountered an error, there will be a log that can give you an idea of what went wrong. You can commit a change to fix the error, and return to the Actions screen to see if a new Workflow successfully bypasses the problem.

This is the same log that you would see when building a configuration Via the command line.

By opening the Workflow with your commit message, you can also download a .zip file of your configuration, which includes a temporary .mapeosettings file. This is helpful for testing out your configuration before building a versioned file to distribute to users, as described in Probando e iterando.

Use conventional commit messages to increment your configuration version

  • feat: this will increase your version to 1.2.0. This commit prefix could be used for major configuration updates.

  • fix: this will increase your version to 1.1.1. This commit prefix could be used for small updates like changing an icon, or adding a field to a category.

  • chore: this will not increase your version. This commit prefix could be used for correcting typos or fixing errors.

You can also manually update the first number in your 1.1.0 version in your package.json file, but Digital Democracy's convention is to only do so to indicate breaking changes. That said, you are free to choose a versioning convention that makes the most sense to you.

Compile a final, versioned release of your configuration

Once you are done making changes, have tested your configuration using a temporary .mapeosettings file (as described in How it works) and in accordance to the process described in Probando e iterando, you can generate a versioned release of your configuration. The way to do so is as follows:

  • Navigate to the Actions tab for your GitHub repository. You should see all of your Workflows again.

  • On the left sidebar, click on the Build & Release link.

  • You should now see a box with the text "This workflow has a workflow_dispatch event trigger" and a button Run workflow. Click the button, and then click Run workflow again in the popup that will appear.

  • Doing so will trigger another Workflow titled "Build and Release."

  • Click on the release to download the versioned .mapeosettings file.

a circular check indicates that the build has completed successfully.

a yellow circle indicates that the build is in process.

a red circle with an X indicates that the build has encountered an error.

The Mapeo GitHub Actions Workflow is set up to dynamically bump the version of your configuration per each workflow. It does so using of adding feat:, fix:, or chore: before your commit message. For example, if you have a configuration with version 1.1.0, the specific version bumps are as follows:

To see a few examples of configuration conventional commit messaging, see the screenshot above in How it works, or check out the commit history on the repository.

When that finished with a green check mark, your versioned build release will be ready. On the top navigation bar, click on Code and your release should appear under the Releases panel in the right sidebar.

⚙️
✅
🟡
🔴
✅
Github.com
basics
Mapeo Default Configuration
Empty Mapeo Configuration
Mapeo Default Configuration
Empty Mapeo Configuration
conventional commit messaging
Mapeo Default Configuration