Git Product home page Git Product logo

tokenreplace's Introduction

page_type languages products description urlFragment
sample
yaml
GitHub
This is a simple example of how to replace tokens in code on-the-fly with a GitHub build action.

Official Microsoft Sample

Introduction

This is a simple example of how to replace tokens in code on-the-fly during a build script. Two examples are provided, one using a build variable (declared as an environment variable in the build script), the other using project secrets (maintained under Settings -> Secrets).

Contents

Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.

File/folder Description
README.md This README file.
LICENSE The license for the sample.
.github/workflows Sample search/replace build action
Example.json Sample json file with UName and PWord placeholders
Example.xml Sample xml file with a CString placeholder

Prerequisites

GitHub account with build/actions enabled.

Setup

Simply copy the .yml file provided and modify to suit the project needs. To store the secrets that will be used in the token replace, use GitHub's Secrets section for your project under Settings -> Secrets. This example project has already stored secrets for "CString" and "PWord" in this GitHub repo and the pipeline is simply pulling the secrets from there for insertion into the script.

Running the sample

GitHub will automatically run .yml files stored in the .github/workflows folder. To enable it on your own repository, simply ensure the .yml file you use is located in your respective repo in the same location.

Key concepts

The purpose of this tool is to show how one can replace text inside of a source file at build-time and replace it with either secrets or environment (build) variables.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

tokenreplace's People

Contributors

joelbyford avatar johnlokerse avatar microsoftopensource avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.