Skip to content

Commit

Permalink
first commit [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
simonegaffurini committed Oct 28, 2023
0 parents commit c00607e
Show file tree
Hide file tree
Showing 68 changed files with 5,817 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .abapgit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
<asx:values>
<DATA>
<MASTER_LANGUAGE>E</MASTER_LANGUAGE>
<STARTING_FOLDER>/src/</STARTING_FOLDER>
<FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
<VERSION_CONSTANT>ZIF_TRM=&gt;VERSION</VERSION_CONSTANT>
</DATA>
</asx:values>
</asx:abap>
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* [email protected]
21 changes: 21 additions & 0 deletions .github/workflows/alignAfterPr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Align after PR
on:
push:
branches:
- 'main'
jobs:
alignAfterPr:
runs-on: ubuntu-latest
steps:
- name: Checkout Regesta Actions
uses: actions/checkout@v2
with:
repository: RegestaItalia/actions
token: ${{ secrets.CI_GITHUB_TOKEN }}
path: actions/regesta
- name: Align after PR
uses: ./actions/regesta/alignAfterPr
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
repoName: ${{ github.event.repository.name }}
mainBranch: ${{ github.ref_name }}
43 changes: 43 additions & 0 deletions .github/workflows/checkVersionUpdate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Check version updated
on:
pull_request:
branches:
- 'main'
jobs:
getCandidateVersion:
runs-on: ubuntu-latest
outputs:
version: ${{ steps.abapVersion.outputs.version }}
steps:
- name: Get current repository version value
uses: RegestaItalia/abapVersion@main
id: abapVersion
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: development
getLatestVersion:
runs-on: ubuntu-latest
outputs:
version: ${{ steps.latestRelease.outputs.release }}
steps:
- name: Get latest release
id: latestRelease
uses: pozetroninc/github-action-get-latest-release@master
with:
token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
excludes: prerelease, draft
compareVersions:
runs-on: ubuntu-latest
needs: [ getCandidateVersion, getLatestVersion ]
steps:
- uses: madhead/semver-utils@latest
id: compareSemver
with:
version: ${{ needs.getCandidateVersion.outputs.version }}
compare-to: ${{ needs.getLatestVersion.outputs.version }}
- if: steps.compareSemver.outputs.comparison-result != '>'
uses: actions/github-script@v3
with:
script: |
core.setFailed('Version should be increased in order to merge create a new release.')
32 changes: 32 additions & 0 deletions .github/workflows/updateReadme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Update Readme (docs.trmregistry.com)
on:
workflow_dispatch:
pull_request:
branches:
- 'development'
paths:
- 'README.md'
- 'TABLE_OF_CONTENTS.md'
jobs:
updateReadme:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
ref: ${{ github.event.pull_request.head.sha }}
path: repo
- name: Checkout Regesta Actions
uses: actions/checkout@v2
with:
repository: RegestaItalia/actions
token: ${{ secrets.CI_GITHUB_TOKEN }}
path: actions/regesta
- name: Update readme
uses: ./actions/regesta/trm/updateReadme
with:
actionPath: actions/regesta/trm/updateReadme
repoFullName: ${{ github.repository }}
branch: ${{ github.ref_name }}
githubToken: ${{ secrets.GITHUB_TOKEN }}
replacePath: server/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 RegestaItalia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# <a href="https://docs.trmregistry.com/#/server/README"><img src="https://docs.trmregistry.com/_media/logo.png" height="40" alt="TRM"></a>

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.3.0-4baaaa.svg)](https://github.com/RegestaItalia/trm-docs/blob/main/CODE_OF_CONDUCT.md)
[![TRM License](https://img.shields.io/endpoint?url=https://trmregistry.com/public/shieldio/license?package=trm-server)](https://trmregistry/#/package/trm-server)
[![TRM Latest version](https://img.shields.io/endpoint?url=https://trmregistry.com/public/shieldio/version?package=trm-server)](https://trmregistry/#/package/trm-server)
[![TRM Installs](https://img.shields.io/endpoint?url=https://trmregistry.com/public/shieldio/downloads?package=trm-server)](https://trmregistry/#/package/trm-server)

TRM Server is the essential component for operations between TRM Client and your development SAP system.

<p align="center">
  <img src="https://docs.trmregistry.com/_media/schema.png" />
</p>

> This package should only be installed on your development systems!
# Basic usage

Typically, trm-server is used by a TRM Client.

When a TRM Client (like [trm-client](https://github.com/RegestaItalia/trm-client)) has to execute any of the functions of trm-server, it makes use od the [SAP NW RFC SDK](https://support.sap.com/en/product/connectors/nwrfcsdk.html).

The SDK connects to the development system, where this package exists, and executes the function.

The result of the function is then returned to the client and the its execution can continue.

## Where should I install this package?

As explained before, on any development system where you want to use a TRM Client.

The reason behind the need to only have this package on a development system (hence the **recommended installation as a temporary package**) is the definition of a TRM package life-cycle.

The packages are installed on a development system and are then transported manually across your SAP system landscape.

# Documentation <!-- {docsify-remove} -->

Full documentation can be seen at [https://docs.trmregistry.com](https://docs.trmregistry.com).

<!-- START TABLE_OF_CONTENTS.md -->
- [Setup Server](docs/setup.md)
- [RFC Functions](docs/rfcFunctions.md)
<!-- END TABLE_OF_CONTENTS.md -->

## Install <!-- {docsify-remove} -->

The first install of this package should be done with [abapGit](https://abapgit.org/).

Updates can be done either by abapGit or with [TRM](https://docs.trmregistry.com).

Follow the install steps documented [here](/docs/setup.md).

## Security: Authorizing users <!-- {docsify-remove} -->

By default, most of the RFC functions in this package are disabled for all users in your system.

This is done for security reasons. A full list of the RFC functions can be seen [here](/docs/rfcFunctions.md).

To enable users, follow [this guide](/docs/setup.md#user-authorization-maintenance).

# Contributing <!-- {docsify-remove} -->

Like every other TRM open-soruce projects, contributions are always welcomed ❤️.

Make sure to open an issue first.

Contributions will be merged upon approval.

[Click here](https://docs.trmregistry.com/#/CONTRIBUTING) for the full list of TRM contribution guidelines.
2 changes: 2 additions & 0 deletions TABLE_OF_CONTENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [Setup Server](server/docs/setup.md)
- [RFC Functions](server/docs/rfcFunctions.md)
Binary file added docs/images/sm30_ztrm_users1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/sm30_ztrm_users2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/sm30_ztrm_users3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c00607e

Please sign in to comment.