External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-02-17 03:00:04 -03:30
Code Issues Packages Projects Releases Wiki Activity

Add help_text to the new fields

Browse Source
This commit is contained in:
Jeff Bradberry
2019-09-27 11:28:42 -04:00
parent e14d4ddec6
commit 6aa6471b7c
4 changed files with 26 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
awx/main/migrations/0092_v360_webhook_mixin.py
View File

@@ -14,32 +14,32 @@ class Migration(migrations.Migration):
migrations.AddField( migrations.AddField(
model_name='jobtemplate', model_name='jobtemplate',
name='webhook_credential', name='webhook_credential',
field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobtemplates', to='main.Credential'), field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobtemplates', to='main.Credential'),
), ),
migrations.AddField( migrations.AddField(
model_name='jobtemplate', model_name='jobtemplate',
name='webhook_key', name='webhook_key',
field=models.CharField(blank=True, max_length=64), field=models.CharField(blank=True, help_text='Shared secret that the webhook service will use to sign requests', max_length=64),
), ),
migrations.AddField( migrations.AddField(
model_name='jobtemplate', model_name='jobtemplate',
name='webhook_service', name='webhook_service',
field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjobtemplate', model_name='workflowjobtemplate',
name='webhook_credential', name='webhook_credential',
field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobtemplates', to='main.Credential'), field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobtemplates', to='main.Credential'),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjobtemplate', model_name='workflowjobtemplate',
name='webhook_key', name='webhook_key',
field=models.CharField(blank=True, max_length=64), field=models.CharField(blank=True, help_text='Shared secret that the webhook service will use to sign requests', max_length=64),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjobtemplate', model_name='workflowjobtemplate',
name='webhook_service', name='webhook_service',
field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16),
), ),
migrations.AlterField( migrations.AlterField(
model_name='unifiedjob', model_name='unifiedjob',

12
awx/main/migrations/0094_v360_webhook_mixin2.py
View File

@@ -14,31 +14,31 @@ class Migration(migrations.Migration):
migrations.AddField( migrations.AddField(
model_name='job', model_name='job',
name='webhook_credential', name='webhook_credential',
field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobs', to='main.Credential'), field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobs', to='main.Credential'),
), ),
migrations.AddField( migrations.AddField(
model_name='job', model_name='job',
name='webhook_guid', name='webhook_guid',
field=models.CharField(blank=True, max_length=128), field=models.CharField(blank=True, help_text='Unique identifier of the event that triggered this webhook', max_length=128),
), ),
migrations.AddField( migrations.AddField(
model_name='job', model_name='job',
name='webhook_service', name='webhook_service',
field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjob', model_name='workflowjob',
name='webhook_credential', name='webhook_credential',
field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobs', to='main.Credential'), field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobs', to='main.Credential'),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjob', model_name='workflowjob',
name='webhook_guid', name='webhook_guid',
field=models.CharField(blank=True, max_length=128), field=models.CharField(blank=True, help_text='Unique identifier of the event that triggered this webhook', max_length=128),
), ),
migrations.AddField( migrations.AddField(
model_name='workflowjob', model_name='workflowjob',
name='webhook_service', name='webhook_service',
field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16),
), ),
] ]

2
awx/main/models/credential/__init__.py
View File

@@ -980,6 +980,7 @@ ManagedCredentialType(
'label': ugettext_noop('Token'), 'label': ugettext_noop('Token'),
'type': 'string', 'type': 'string',
'secret': True, 'secret': True,
'help_text': ugettext_noop('This token needs to come from your profile settings in Github')
}], }],
'required': ['token'], 'required': ['token'],
}, },
@@ -996,6 +997,7 @@ ManagedCredentialType(
'label': ugettext_noop('Token'), 'label': ugettext_noop('Token'),
'type': 'string', 'type': 'string',
'secret': True, 'secret': True,
'help_text': ugettext_noop('This token needs to come from your profile settings in Gitlab')
}], }],
'required': ['token'], 'required': ['token'],
}, },

18
awx/main/models/mixins.py
View File

@@ -503,18 +503,21 @@ class WebhookTemplateMixin(models.Model):
webhook_service = models.CharField( webhook_service = models.CharField(
max_length=16, max_length=16,
choices=SERVICES, choices=SERVICES,
blank=True blank=True,
help_text=_('Service that webhook requests will be accepted from')
) )
webhook_key = prevent_search(models.CharField( webhook_key = prevent_search(models.CharField(
max_length=64, max_length=64,
blank=True blank=True,
help_text=_('Shared secret that the webhook service will use to sign requests')
)) ))
webhook_credential = models.ForeignKey( webhook_credential = models.ForeignKey(
'Credential', 'Credential',
blank=True, blank=True,
null=True, null=True,
on_delete=models.SET_NULL, on_delete=models.SET_NULL,
related_name='%(class)ss' related_name='%(class)ss',
help_text=_('Personal Access Token for posting back the status to the service API')
) )
def rotate_webhook_key(self): def rotate_webhook_key(self):
@@ -544,18 +547,21 @@ class WebhookMixin(models.Model):
webhook_service = models.CharField( webhook_service = models.CharField(
max_length=16, max_length=16,
choices=SERVICES, choices=SERVICES,
blank=True blank=True,
help_text=_('Service that webhook requests will be accepted from')
) )
webhook_credential = models.ForeignKey( webhook_credential = models.ForeignKey(
'Credential', 'Credential',
blank=True, blank=True,
null=True, null=True,
on_delete=models.SET_NULL, on_delete=models.SET_NULL,
related_name='%(class)ss' related_name='%(class)ss',
help_text=_('Personal Access Token for posting back the status to the service API')
) )
webhook_guid = models.CharField( webhook_guid = models.CharField(
blank=True, blank=True,
max_length=128 max_length=128,
help_text=_('Unique identifier of the event that triggered this webhook')
) )
def update_webhook_status(self, status): def update_webhook_status(self, status):